3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
24 use MediaWiki\Session\SessionManager
;
25 use MediaWiki\Session\Token
;
26 use MediaWiki\Auth\AuthManager
;
27 use MediaWiki\Auth\AuthenticationResponse
;
28 use MediaWiki\Auth\AuthenticationRequest
;
29 use MediaWiki\User\UserIdentity
;
30 use MediaWiki\Logger\LoggerFactory
;
32 use Wikimedia\ScopedCallback
;
33 use Wikimedia\Rdbms\Database
;
34 use Wikimedia\Rdbms\DBExpectedError
;
35 use Wikimedia\Rdbms\IDatabase
;
38 * The User object encapsulates all of the user-specific settings (user_id,
39 * name, rights, email address, options, last login time). Client
40 * classes use the getXXX() functions to access these fields. These functions
41 * do all the work of determining whether the user is logged in,
42 * whether the requested option can be satisfied from cookies or
43 * whether a database query is needed. Most of the settings needed
44 * for rendering normal pages are set in the cookie to minimize use
47 class User
implements IDBAccessObject
, UserIdentity
{
49 * @const int Number of characters in user_token field.
51 const TOKEN_LENGTH
= 32;
54 * @const string An invalid value for user_token
56 const INVALID_TOKEN
= '*** INVALID ***';
59 * @const int Serialized record version.
64 * Exclude user options that are set to their default value.
67 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
72 const CHECK_USER_RIGHTS
= true;
77 const IGNORE_USER_RIGHTS
= false;
80 * Array of Strings List of member variables which are saved to the
81 * shared cache (memcached). Any operation which changes the
82 * corresponding database fields must call a cache-clearing function.
85 protected static $mCacheVars = [
93 'mEmailAuthenticated',
100 // user_properties table
107 * Array of Strings Core rights.
108 * Each of these should have a corresponding message of the form
112 protected static $mCoreRights = [
160 'move-categorypages',
161 'move-rootuserpages',
165 'override-export-depth',
187 'userrights-interwiki',
195 * String Cached results of getAllRights()
197 protected static $mAllRights = false;
199 /** Cache variables */
212 /** @var string TS_MW timestamp from the DB */
214 /** @var string TS_MW timestamp from cache */
215 protected $mQuickTouched;
219 public $mEmailAuthenticated;
221 protected $mEmailToken;
223 protected $mEmailTokenExpires;
225 protected $mRegistration;
227 protected $mEditCount;
228 /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
229 protected $mGroupMemberships;
231 protected $mOptionOverrides;
235 * Bool Whether the cache variables have been loaded.
238 public $mOptionsLoaded;
241 * Array with already loaded items or true if all items have been loaded.
243 protected $mLoadedItems = [];
247 * String Initialization data source if mLoadedItems!==true. May be one of:
248 * - 'defaults' anonymous user initialised from class defaults
249 * - 'name' initialise from mName
250 * - 'id' initialise from mId
251 * - 'actor' initialise from mActorId
252 * - 'session' log in from session if possible
254 * Use the User::newFrom*() family of functions to set this.
259 * Lazy-initialized variables, invalidated with clearInstanceCache
263 protected $mDatePreference;
271 protected $mBlockreason;
273 protected $mEffectiveGroups;
275 protected $mImplicitGroups;
277 protected $mFormerGroups;
279 protected $mGlobalBlock;
287 /** @var WebRequest */
294 protected $mAllowUsertalk;
297 private $mBlockedFromCreateAccount = false;
299 /** @var int User::READ_* constant bitfield used to load data */
300 protected $queryFlagsUsed = self
::READ_NORMAL
;
302 public static $idCacheByName = [];
305 * Lightweight constructor for an anonymous user.
306 * Use the User::newFrom* factory functions for other kinds of users.
310 * @see newFromActorId()
311 * @see newFromConfirmationCode()
312 * @see newFromSession()
315 public function __construct() {
316 $this->clearInstanceCache( 'defaults' );
322 public function __toString() {
323 return (string)$this->getName();
327 * Test if it's safe to load this User object.
329 * You should typically check this before using $wgUser or
330 * RequestContext::getUser in a method that might be called before the
331 * system has been fully initialized. If the object is unsafe, you should
332 * use an anonymous user:
334 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
340 public function isSafeToLoad() {
341 global $wgFullyInitialised;
343 // The user is safe to load if:
344 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
345 // * mLoadedItems === true (already loaded)
346 // * mFrom !== 'session' (sessions not involved at all)
348 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
349 $this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
353 * Load the user table data for this object from the source given by mFrom.
355 * @param int $flags User::READ_* constant bitfield
357 public function load( $flags = self
::READ_NORMAL
) {
358 global $wgFullyInitialised;
360 if ( $this->mLoadedItems
=== true ) {
364 // Set it now to avoid infinite recursion in accessors
365 $oldLoadedItems = $this->mLoadedItems
;
366 $this->mLoadedItems
= true;
367 $this->queryFlagsUsed
= $flags;
369 // If this is called too early, things are likely to break.
370 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
371 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
372 ->warning( 'User::loadFromSession called before the end of Setup.php', [
373 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
375 $this->loadDefaults();
376 $this->mLoadedItems
= $oldLoadedItems;
380 switch ( $this->mFrom
) {
382 $this->loadDefaults();
385 // Make sure this thread sees its own changes
386 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
387 if ( $lb->hasOrMadeRecentMasterChanges() ) {
388 $flags |
= self
::READ_LATEST
;
389 $this->queryFlagsUsed
= $flags;
392 $this->mId
= self
::idFromName( $this->mName
, $flags );
394 // Nonexistent user placeholder object
395 $this->loadDefaults( $this->mName
);
397 $this->loadFromId( $flags );
401 // Make sure this thread sees its own changes, if the ID isn't 0
402 if ( $this->mId
!= 0 ) {
403 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
404 if ( $lb->hasOrMadeRecentMasterChanges() ) {
405 $flags |
= self
::READ_LATEST
;
406 $this->queryFlagsUsed
= $flags;
410 $this->loadFromId( $flags );
413 // Make sure this thread sees its own changes
414 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
415 if ( $lb->hasOrMadeRecentMasterChanges() ) {
416 $flags |
= self
::READ_LATEST
;
417 $this->queryFlagsUsed
= $flags;
420 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
421 $row = wfGetDB( $index )->selectRow(
423 [ 'actor_user', 'actor_name' ],
424 [ 'actor_id' => $this->mActorId
],
431 $this->loadDefaults();
432 } elseif ( $row->actor_user
) {
433 $this->mId
= $row->actor_user
;
434 $this->loadFromId( $flags );
436 $this->loadDefaults( $row->actor_name
);
440 if ( !$this->loadFromSession() ) {
441 // Loading from session failed. Load defaults.
442 $this->loadDefaults();
444 Hooks
::run( 'UserLoadAfterLoadFromSession', [ $this ] );
447 throw new UnexpectedValueException(
448 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
453 * Load user table data, given mId has already been set.
454 * @param int $flags User::READ_* constant bitfield
455 * @return bool False if the ID does not exist, true otherwise
457 public function loadFromId( $flags = self
::READ_NORMAL
) {
458 if ( $this->mId
== 0 ) {
459 // Anonymous users are not in the database (don't need cache)
460 $this->loadDefaults();
464 // Try cache (unless this needs data from the master DB).
465 // NOTE: if this thread called saveSettings(), the cache was cleared.
466 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
468 if ( !$this->loadFromDatabase( $flags ) ) {
469 // Can't load from ID
473 $this->loadFromCache();
476 $this->mLoadedItems
= true;
477 $this->queryFlagsUsed
= $flags;
484 * @param string $wikiId
487 public static function purge( $wikiId, $userId ) {
488 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
489 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
490 $cache->delete( $key );
495 * @param WANObjectCache $cache
498 protected function getCacheKey( WANObjectCache
$cache ) {
499 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
501 return $cache->makeGlobalKey( 'user', 'id', $lbFactory->getLocalDomainID(), $this->mId
);
505 * @param WANObjectCache $cache
509 public function getMutableCacheKeys( WANObjectCache
$cache ) {
510 $id = $this->getId();
512 return $id ?
[ $this->getCacheKey( $cache ) ] : [];
516 * Load user data from shared cache, given mId has already been set.
521 protected function loadFromCache() {
522 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
523 $data = $cache->getWithSetCallback(
524 $this->getCacheKey( $cache ),
526 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
527 $setOpts +
= Database
::getCacheSetOptions( wfGetDB( DB_REPLICA
) );
528 wfDebug( "User: cache miss for user {$this->mId}\n" );
530 $this->loadFromDatabase( self
::READ_NORMAL
);
532 $this->loadOptions();
535 foreach ( self
::$mCacheVars as $name ) {
536 $data[$name] = $this->$name;
539 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->mTouched
), $ttl );
541 // if a user group membership is about to expire, the cache needs to
542 // expire at that time (T163691)
543 foreach ( $this->mGroupMemberships
as $ugm ) {
544 if ( $ugm->getExpiry() ) {
545 $secondsUntilExpiry = wfTimestamp( TS_UNIX
, $ugm->getExpiry() ) - time();
546 if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
547 $ttl = $secondsUntilExpiry;
554 [ 'pcTTL' => $cache::TTL_PROC_LONG
, 'version' => self
::VERSION
]
557 // Restore from cache
558 foreach ( self
::$mCacheVars as $name ) {
559 $this->$name = $data[$name];
565 /** @name newFrom*() static factory methods */
569 * Static factory method for creation from username.
571 * This is slightly less efficient than newFromId(), so use newFromId() if
572 * you have both an ID and a name handy.
574 * @param string $name Username, validated by Title::newFromText()
575 * @param string|bool $validate Validate username. Takes the same parameters as
576 * User::getCanonicalName(), except that true is accepted as an alias
577 * for 'valid', for BC.
579 * @return User|bool User object, or false if the username is invalid
580 * (e.g. if it contains illegal characters or is an IP address). If the
581 * username is not present in the database, the result will be a user object
582 * with a name, zero user ID and default settings.
584 public static function newFromName( $name, $validate = 'valid' ) {
585 if ( $validate === true ) {
588 $name = self
::getCanonicalName( $name, $validate );
589 if ( $name === false ) {
593 // Create unloaded user object
597 $u->setItemLoaded( 'name' );
603 * Static factory method for creation from a given user ID.
605 * @param int $id Valid user ID
606 * @return User The corresponding User object
608 public static function newFromId( $id ) {
612 $u->setItemLoaded( 'id' );
617 * Static factory method for creation from a given actor ID.
620 * @param int $id Valid actor ID
621 * @return User The corresponding User object
623 public static function newFromActorId( $id ) {
624 global $wgActorTableSchemaMigrationStage;
626 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
627 // but it does little harm and might be needed for write callers loading a User.
628 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) ) {
629 throw new BadMethodCallException(
630 'Cannot use ' . __METHOD__
631 . ' when $wgActorTableSchemaMigrationStage lacks SCHEMA_COMPAT_NEW'
638 $u->setItemLoaded( 'actor' );
643 * Returns a User object corresponding to the given UserIdentity.
647 * @param UserIdentity $identity
651 public static function newFromIdentity( UserIdentity
$identity ) {
652 if ( $identity instanceof User
) {
656 return self
::newFromAnyId(
657 $identity->getId() === 0 ?
null : $identity->getId(),
658 $identity->getName() === '' ?
null : $identity->getName(),
659 $identity->getActorId() === 0 ?
null : $identity->getActorId()
664 * Static factory method for creation from an ID, name, and/or actor ID
666 * This does not check that the ID, name, and actor ID all correspond to
670 * @param int|null $userId User ID, if known
671 * @param string|null $userName User name, if known
672 * @param int|null $actorId Actor ID, if known
675 public static function newFromAnyId( $userId, $userName, $actorId ) {
676 global $wgActorTableSchemaMigrationStage;
679 $user->mFrom
= 'defaults';
681 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
682 // but it does little harm and might be needed for write callers loading a User.
683 if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) && $actorId !== null ) {
684 $user->mActorId
= (int)$actorId;
685 if ( $user->mActorId
!== 0 ) {
686 $user->mFrom
= 'actor';
688 $user->setItemLoaded( 'actor' );
691 if ( $userName !== null && $userName !== '' ) {
692 $user->mName
= $userName;
693 $user->mFrom
= 'name';
694 $user->setItemLoaded( 'name' );
697 if ( $userId !== null ) {
698 $user->mId
= (int)$userId;
699 if ( $user->mId
!== 0 ) {
702 $user->setItemLoaded( 'id' );
705 if ( $user->mFrom
=== 'defaults' ) {
706 throw new InvalidArgumentException(
707 'Cannot create a user with no name, no ID, and no actor ID'
715 * Factory method to fetch whichever user has a given email confirmation code.
716 * This code is generated when an account is created or its e-mail address
719 * If the code is invalid or has expired, returns NULL.
721 * @param string $code Confirmation code
722 * @param int $flags User::READ_* bitfield
725 public static function newFromConfirmationCode( $code, $flags = 0 ) {
726 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
727 ?
wfGetDB( DB_MASTER
)
728 : wfGetDB( DB_REPLICA
);
730 $id = $db->selectField(
734 'user_email_token' => md5( $code ),
735 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
739 return $id ? self
::newFromId( $id ) : null;
743 * Create a new user object using data from session. If the login
744 * credentials are invalid, the result is an anonymous user.
746 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
749 public static function newFromSession( WebRequest
$request = null ) {
751 $user->mFrom
= 'session';
752 $user->mRequest
= $request;
757 * Create a new user object from a user row.
758 * The row should have the following fields from the user table in it:
759 * - either user_name or user_id to load further data if needed (or both)
761 * - all other fields (email, etc.)
762 * It is useless to provide the remaining fields if either user_id,
763 * user_name and user_real_name are not provided because the whole row
764 * will be loaded once more from the database when accessing them.
766 * @param stdClass $row A row from the user table
767 * @param array|null $data Further data to load into the object
768 * (see User::loadFromRow for valid keys)
771 public static function newFromRow( $row, $data = null ) {
773 $user->loadFromRow( $row, $data );
778 * Static factory method for creation of a "system" user from username.
780 * A "system" user is an account that's used to attribute logged actions
781 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
782 * might include the 'Maintenance script' or 'Conversion script' accounts
783 * used by various scripts in the maintenance/ directory or accounts such
784 * as 'MediaWiki message delivery' used by the MassMessage extension.
786 * This can optionally create the user if it doesn't exist, and "steal" the
787 * account if it does exist.
789 * "Stealing" an existing user is intended to make it impossible for normal
790 * authentication processes to use the account, effectively disabling the
791 * account for normal use:
792 * - Email is invalidated, to prevent account recovery by emailing a
793 * temporary password and to disassociate the account from the existing
795 * - The token is set to a magic invalid value, to kill existing sessions
796 * and to prevent $this->setToken() calls from resetting the token to a
798 * - SessionManager is instructed to prevent new sessions for the user, to
799 * do things like deauthorizing OAuth consumers.
800 * - AuthManager is instructed to revoke access, to invalidate or remove
801 * passwords and other credentials.
803 * @param string $name Username
804 * @param array $options Options are:
805 * - validate: As for User::getCanonicalName(), default 'valid'
806 * - create: Whether to create the user if it doesn't already exist, default true
807 * - steal: Whether to "disable" the account for normal use if it already
808 * exists, default false
812 public static function newSystemUser( $name, $options = [] ) {
814 'validate' => 'valid',
819 $name = self
::getCanonicalName( $name, $options['validate'] );
820 if ( $name === false ) {
824 $dbr = wfGetDB( DB_REPLICA
);
825 $userQuery = self
::getQueryInfo();
826 $row = $dbr->selectRow(
827 $userQuery['tables'],
828 $userQuery['fields'],
829 [ 'user_name' => $name ],
835 // Try the master database...
836 $dbw = wfGetDB( DB_MASTER
);
837 $row = $dbw->selectRow(
838 $userQuery['tables'],
839 $userQuery['fields'],
840 [ 'user_name' => $name ],
848 // No user. Create it?
849 return $options['create']
850 ? self
::createNew( $name, [ 'token' => self
::INVALID_TOKEN
] )
854 $user = self
::newFromRow( $row );
856 // A user is considered to exist as a non-system user if it can
857 // authenticate, or has an email set, or has a non-invalid token.
858 if ( $user->mEmail ||
$user->mToken
!== self
::INVALID_TOKEN ||
859 AuthManager
::singleton()->userCanAuthenticate( $name )
861 // User exists. Steal it?
862 if ( !$options['steal'] ) {
866 AuthManager
::singleton()->revokeAccessForUser( $name );
868 $user->invalidateEmail();
869 $user->mToken
= self
::INVALID_TOKEN
;
870 $user->saveSettings();
871 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
880 * Get the username corresponding to a given user ID
881 * @param int $id User ID
882 * @return string|bool The corresponding username
884 public static function whoIs( $id ) {
885 return UserCache
::singleton()->getProp( $id, 'name' );
889 * Get the real name of a user given their user ID
891 * @param int $id User ID
892 * @return string|bool The corresponding user's real name
894 public static function whoIsReal( $id ) {
895 return UserCache
::singleton()->getProp( $id, 'real_name' );
899 * Get database id given a user name
900 * @param string $name Username
901 * @param int $flags User::READ_* constant bitfield
902 * @return int|null The corresponding user's ID, or null if user is nonexistent
904 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
905 // Don't explode on self::$idCacheByName[$name] if $name is not a string but e.g. a User object
906 $name = (string)$name;
907 $nt = Title
::makeTitleSafe( NS_USER
, $name );
908 if ( is_null( $nt ) ) {
913 if ( !( $flags & self
::READ_LATEST
) && array_key_exists( $name, self
::$idCacheByName ) ) {
914 return self
::$idCacheByName[$name];
917 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
918 $db = wfGetDB( $index );
923 [ 'user_name' => $nt->getText() ],
928 if ( $s === false ) {
931 $result = (int)$s->user_id
;
934 self
::$idCacheByName[$name] = $result;
936 if ( count( self
::$idCacheByName ) > 1000 ) {
937 self
::$idCacheByName = [];
944 * Reset the cache used in idFromName(). For use in tests.
946 public static function resetIdByNameCache() {
947 self
::$idCacheByName = [];
951 * Does the string match an anonymous IP address?
953 * This function exists for username validation, in order to reject
954 * usernames which are similar in form to IP addresses. Strings such
955 * as 300.300.300.300 will return true because it looks like an IP
956 * address, despite not being strictly valid.
958 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
959 * address because the usemod software would "cloak" anonymous IP
960 * addresses like this, if we allowed accounts like this to be created
961 * new users could get the old edits of these anonymous users.
963 * @param string $name Name to match
966 public static function isIP( $name ) {
967 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
968 || IP
::isIPv6( $name );
972 * Is the user an IP range?
977 public function isIPRange() {
978 return IP
::isValidRange( $this->mName
);
982 * Is the input a valid username?
984 * Checks if the input is a valid username, we don't want an empty string,
985 * an IP address, anything that contains slashes (would mess up subpages),
986 * is longer than the maximum allowed username size or doesn't begin with
989 * @param string $name Name to match
992 public static function isValidUserName( $name ) {
993 global $wgMaxNameChars;
996 || self
::isIP( $name )
997 ||
strpos( $name, '/' ) !== false
998 ||
strlen( $name ) > $wgMaxNameChars
999 ||
$name != MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name )
1004 // Ensure that the name can't be misresolved as a different title,
1005 // such as with extra namespace keys at the start.
1006 $parsed = Title
::newFromText( $name );
1007 if ( is_null( $parsed )
1008 ||
$parsed->getNamespace()
1009 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
1013 // Check an additional blacklist of troublemaker characters.
1014 // Should these be merged into the title char list?
1015 $unicodeBlacklist = '/[' .
1016 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
1017 '\x{00a0}' . # non-breaking space
1018 '\x{2000}-\x{200f}' . # various whitespace
1019 '\x{2028}-\x{202f}' . # breaks and control chars
1020 '\x{3000}' . # ideographic space
1021 '\x{e000}-\x{f8ff}' . # private use
1023 if ( preg_match( $unicodeBlacklist, $name ) ) {
1031 * Usernames which fail to pass this function will be blocked
1032 * from user login and new account registrations, but may be used
1033 * internally by batch processes.
1035 * If an account already exists in this form, login will be blocked
1036 * by a failure to pass this function.
1038 * @param string $name Name to match
1041 public static function isUsableName( $name ) {
1042 global $wgReservedUsernames;
1043 // Must be a valid username, obviously ;)
1044 if ( !self
::isValidUserName( $name ) ) {
1048 static $reservedUsernames = false;
1049 if ( !$reservedUsernames ) {
1050 $reservedUsernames = $wgReservedUsernames;
1051 Hooks
::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
1054 // Certain names may be reserved for batch processes.
1055 foreach ( $reservedUsernames as $reserved ) {
1056 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
1057 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
1059 if ( $reserved == $name ) {
1067 * Return the users who are members of the given group(s). In case of multiple groups,
1068 * users who are members of at least one of them are returned.
1070 * @param string|array $groups A single group name or an array of group names
1071 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
1072 * records; larger values are ignored.
1073 * @param int|null $after ID the user to start after
1074 * @return UserArrayFromResult
1076 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
1077 if ( $groups === [] ) {
1078 return UserArrayFromResult
::newFromIDs( [] );
1081 $groups = array_unique( (array)$groups );
1082 $limit = min( 5000, $limit );
1084 $conds = [ 'ug_group' => $groups ];
1085 if ( $after !== null ) {
1086 $conds[] = 'ug_user > ' . (int)$after;
1089 $dbr = wfGetDB( DB_REPLICA
);
1090 $ids = $dbr->selectFieldValues(
1097 'ORDER BY' => 'ug_user',
1101 return UserArray
::newFromIDs( $ids );
1105 * Usernames which fail to pass this function will be blocked
1106 * from new account registrations, but may be used internally
1107 * either by batch processes or by user accounts which have
1108 * already been created.
1110 * Additional blacklisting may be added here rather than in
1111 * isValidUserName() to avoid disrupting existing accounts.
1113 * @param string $name String to match
1116 public static function isCreatableName( $name ) {
1117 global $wgInvalidUsernameCharacters;
1119 // Ensure that the username isn't longer than 235 bytes, so that
1120 // (at least for the builtin skins) user javascript and css files
1121 // will work. (T25080)
1122 if ( strlen( $name ) > 235 ) {
1123 wfDebugLog( 'username', __METHOD__
.
1124 ": '$name' invalid due to length" );
1128 // Preg yells if you try to give it an empty string
1129 if ( $wgInvalidUsernameCharacters !== '' &&
1130 preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name )
1132 wfDebugLog( 'username', __METHOD__
.
1133 ": '$name' invalid due to wgInvalidUsernameCharacters" );
1137 return self
::isUsableName( $name );
1141 * Is the input a valid password for this user?
1143 * @param string $password Desired password
1146 public function isValidPassword( $password ) {
1147 // simple boolean wrapper for checkPasswordValidity
1148 return $this->checkPasswordValidity( $password )->isGood();
1152 * Given unvalidated password input, return error message on failure.
1154 * @param string $password Desired password
1155 * @return bool|string|array True on success, string or array of error message on failure
1156 * @deprecated since 1.33, use checkPasswordValidity
1158 public function getPasswordValidity( $password ) {
1159 wfDeprecated( __METHOD__
, '1.33' );
1161 $result = $this->checkPasswordValidity( $password );
1162 if ( $result->isGood() ) {
1167 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
1168 $messages[] = $error['message'];
1170 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
1171 $messages[] = $warning['message'];
1173 if ( count( $messages ) === 1 ) {
1174 return $messages[0];
1181 * Check if this is a valid password for this user
1183 * Returns a Status object with a set of messages describing
1184 * problems with the password. If the return status is fatal,
1185 * the action should be refused and the password should not be
1186 * checked at all (this is mainly meant for DoS mitigation).
1187 * If the return value is OK but not good, the password can be checked,
1188 * but the user should not be able to set their password to this.
1189 * The value of the returned Status object will be an array which
1190 * can have the following fields:
1191 * - forceChange (bool): if set to true, the user should not be
1192 * allowed to log with this password unless they change it during
1193 * the login process (see ResetPasswordSecondaryAuthenticationProvider).
1194 * - suggestChangeOnLogin (bool): if set to true, the user should be prompted for
1195 * a password change on login.
1197 * @param string $password Desired password
1201 public function checkPasswordValidity( $password ) {
1202 global $wgPasswordPolicy;
1204 $upp = new UserPasswordPolicy(
1205 $wgPasswordPolicy['policies'],
1206 $wgPasswordPolicy['checks']
1209 $status = Status
::newGood( [] );
1210 $result = false; // init $result to false for the internal checks
1212 if ( !Hooks
::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1213 $status->error( $result );
1217 if ( $result === false ) {
1218 $status->merge( $upp->checkUserPassword( $this, $password ), true );
1222 if ( $result === true ) {
1226 $status->error( $result );
1227 return $status; // the isValidPassword hook set a string $result and returned true
1231 * Given unvalidated user input, return a canonical username, or false if
1232 * the username is invalid.
1233 * @param string $name User input
1234 * @param string|bool $validate Type of validation to use:
1235 * - false No validation
1236 * - 'valid' Valid for batch processes
1237 * - 'usable' Valid for batch processes and login
1238 * - 'creatable' Valid for batch processes, login and account creation
1240 * @throws InvalidArgumentException
1241 * @return bool|string
1243 public static function getCanonicalName( $name, $validate = 'valid' ) {
1244 // Force usernames to capital
1245 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
1247 # Reject names containing '#'; these will be cleaned up
1248 # with title normalisation, but then it's too late to
1250 if ( strpos( $name, '#' ) !== false ) {
1254 // Clean up name according to title rules,
1255 // but only when validation is requested (T14654)
1256 $t = ( $validate !== false ) ?
1257 Title
::newFromText( $name, NS_USER
) : Title
::makeTitle( NS_USER
, $name );
1258 // Check for invalid titles
1259 if ( is_null( $t ) ||
$t->getNamespace() !== NS_USER ||
$t->isExternal() ) {
1263 $name = $t->getText();
1265 switch ( $validate ) {
1269 if ( !self
::isValidUserName( $name ) ) {
1274 if ( !self
::isUsableName( $name ) ) {
1279 if ( !self
::isCreatableName( $name ) ) {
1284 throw new InvalidArgumentException(
1285 'Invalid parameter value for $validate in ' . __METHOD__
);
1291 * Return a random password.
1293 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1294 * @return string New random password
1296 public static function randomPassword() {
1297 global $wgMinimalPasswordLength;
1298 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1302 * Set cached properties to default.
1304 * @note This no longer clears uncached lazy-initialised properties;
1305 * the constructor does that instead.
1307 * @param string|bool $name
1309 public function loadDefaults( $name = false ) {
1311 $this->mName
= $name;
1312 $this->mActorId
= null;
1313 $this->mRealName
= '';
1315 $this->mOptionOverrides
= null;
1316 $this->mOptionsLoaded
= false;
1318 $loggedOut = $this->mRequest
&& !defined( 'MW_NO_SESSION' )
1319 ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1320 if ( $loggedOut !== 0 ) {
1321 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1323 $this->mTouched
= '1'; # Allow any pages to be cached
1326 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1327 $this->mEmailAuthenticated
= null;
1328 $this->mEmailToken
= '';
1329 $this->mEmailTokenExpires
= null;
1330 $this->mRegistration
= wfTimestamp( TS_MW
);
1331 $this->mGroupMemberships
= [];
1333 Hooks
::run( 'UserLoadDefaults', [ $this, $name ] );
1337 * Return whether an item has been loaded.
1339 * @param string $item Item to check. Current possibilities:
1343 * @param string $all 'all' to check if the whole object has been loaded
1344 * or any other string to check if only the item is available (e.g.
1348 public function isItemLoaded( $item, $all = 'all' ) {
1349 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1350 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1354 * Set that an item has been loaded
1356 * @param string $item
1358 protected function setItemLoaded( $item ) {
1359 if ( is_array( $this->mLoadedItems
) ) {
1360 $this->mLoadedItems
[$item] = true;
1365 * Load user data from the session.
1367 * @return bool True if the user is logged in, false otherwise.
1369 private function loadFromSession() {
1372 Hooks
::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1373 if ( $result !== null ) {
1377 // MediaWiki\Session\Session already did the necessary authentication of the user
1378 // returned here, so just use it if applicable.
1379 $session = $this->getRequest()->getSession();
1380 $user = $session->getUser();
1381 if ( $user->isLoggedIn() ) {
1382 $this->loadFromUserObject( $user );
1383 if ( $user->isBlocked() ) {
1384 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1385 // every session load, because an autoblocked editor might not edit again from the same
1386 // IP address after being blocked.
1387 $this->trackBlockWithCookie();
1390 // Other code expects these to be set in the session, so set them.
1391 $session->set( 'wsUserID', $this->getId() );
1392 $session->set( 'wsUserName', $this->getName() );
1393 $session->set( 'wsToken', $this->getToken() );
1402 * Set the 'BlockID' cookie depending on block type and user authentication status.
1404 public function trackBlockWithCookie() {
1405 $block = $this->getBlock();
1406 if ( $block && $this->getRequest()->getCookie( 'BlockID' ) === null ) {
1407 $config = RequestContext
::getMain()->getConfig();
1408 $shouldSetCookie = false;
1410 if ( $this->isAnon() && $config->get( 'CookieSetOnIpBlock' ) ) {
1411 // If user is logged-out, set a cookie to track the Block
1412 $shouldSetCookie = in_array( $block->getType(), [
1413 Block
::TYPE_IP
, Block
::TYPE_RANGE
1415 if ( $shouldSetCookie ) {
1416 $block->setCookie( $this->getRequest()->response() );
1418 } elseif ( $this->isLoggedIn() && $config->get( 'CookieSetOnAutoblock' ) ) {
1419 $shouldSetCookie = $block->getType() === Block
::TYPE_USER
&& $block->isAutoblocking();
1420 if ( $shouldSetCookie ) {
1421 $block->setCookie( $this->getRequest()->response() );
1428 * Load user and user_group data from the database.
1429 * $this->mId must be set, this is how the user is identified.
1431 * @param int $flags User::READ_* constant bitfield
1432 * @return bool True if the user exists, false if the user is anonymous
1434 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1436 $this->mId
= intval( $this->mId
);
1438 if ( !$this->mId
) {
1439 // Anonymous users are not in the database
1440 $this->loadDefaults();
1444 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1445 $db = wfGetDB( $index );
1447 $userQuery = self
::getQueryInfo();
1448 $s = $db->selectRow(
1449 $userQuery['tables'],
1450 $userQuery['fields'],
1451 [ 'user_id' => $this->mId
],
1457 $this->queryFlagsUsed
= $flags;
1458 Hooks
::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1460 if ( $s !== false ) {
1461 // Initialise user table data
1462 $this->loadFromRow( $s );
1463 $this->mGroupMemberships
= null; // deferred
1464 $this->getEditCount(); // revalidation for nulls
1470 $this->loadDefaults();
1476 * Initialize this object from a row from the user table.
1478 * @param stdClass $row Row from the user table to load.
1479 * @param array|null $data Further user data to load into the object
1481 * user_groups Array of arrays or stdClass result rows out of the user_groups
1482 * table. Previously you were supposed to pass an array of strings
1483 * here, but we also need expiry info nowadays, so an array of
1484 * strings is ignored.
1485 * user_properties Array with properties out of the user_properties table
1487 protected function loadFromRow( $row, $data = null ) {
1488 global $wgActorTableSchemaMigrationStage;
1490 if ( !is_object( $row ) ) {
1491 throw new InvalidArgumentException( '$row must be an object' );
1496 $this->mGroupMemberships
= null; // deferred
1498 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
1499 // but it does little harm and might be needed for write callers loading a User.
1500 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
1501 if ( isset( $row->actor_id
) ) {
1502 $this->mActorId
= (int)$row->actor_id
;
1503 if ( $this->mActorId
!== 0 ) {
1504 $this->mFrom
= 'actor';
1506 $this->setItemLoaded( 'actor' );
1512 if ( isset( $row->user_name
) && $row->user_name
!== '' ) {
1513 $this->mName
= $row->user_name
;
1514 $this->mFrom
= 'name';
1515 $this->setItemLoaded( 'name' );
1520 if ( isset( $row->user_real_name
) ) {
1521 $this->mRealName
= $row->user_real_name
;
1522 $this->setItemLoaded( 'realname' );
1527 if ( isset( $row->user_id
) ) {
1528 $this->mId
= intval( $row->user_id
);
1529 if ( $this->mId
!== 0 ) {
1530 $this->mFrom
= 'id';
1532 $this->setItemLoaded( 'id' );
1537 if ( isset( $row->user_id
) && isset( $row->user_name
) && $row->user_name
!== '' ) {
1538 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1541 if ( isset( $row->user_editcount
) ) {
1542 $this->mEditCount
= $row->user_editcount
;
1547 if ( isset( $row->user_touched
) ) {
1548 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1553 if ( isset( $row->user_token
) ) {
1554 // The definition for the column is binary(32), so trim the NULs
1555 // that appends. The previous definition was char(32), so trim
1557 $this->mToken
= rtrim( $row->user_token
, " \0" );
1558 if ( $this->mToken
=== '' ) {
1559 $this->mToken
= null;
1565 if ( isset( $row->user_email
) ) {
1566 $this->mEmail
= $row->user_email
;
1567 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1568 $this->mEmailToken
= $row->user_email_token
;
1569 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1570 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1576 $this->mLoadedItems
= true;
1579 if ( is_array( $data ) ) {
1580 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1581 if ( $data['user_groups'] === [] ) {
1582 $this->mGroupMemberships
= [];
1584 $firstGroup = reset( $data['user_groups'] );
1585 if ( is_array( $firstGroup ) ||
is_object( $firstGroup ) ) {
1586 $this->mGroupMemberships
= [];
1587 foreach ( $data['user_groups'] as $row ) {
1588 $ugm = UserGroupMembership
::newFromRow( (object)$row );
1589 $this->mGroupMemberships
[$ugm->getGroup()] = $ugm;
1594 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1595 $this->loadOptions( $data['user_properties'] );
1601 * Load the data for this user object from another user object.
1605 protected function loadFromUserObject( $user ) {
1607 foreach ( self
::$mCacheVars as $var ) {
1608 $this->$var = $user->$var;
1613 * Load the groups from the database if they aren't already loaded.
1615 private function loadGroups() {
1616 if ( is_null( $this->mGroupMemberships
) ) {
1617 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1618 ?
wfGetDB( DB_MASTER
)
1619 : wfGetDB( DB_REPLICA
);
1620 $this->mGroupMemberships
= UserGroupMembership
::getMembershipsForUser(
1626 * Add the user to the group if he/she meets given criteria.
1628 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1629 * possible to remove manually via Special:UserRights. In such case it
1630 * will not be re-added automatically. The user will also not lose the
1631 * group if they no longer meet the criteria.
1633 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1635 * @return array Array of groups the user has been promoted to.
1637 * @see $wgAutopromoteOnce
1639 public function addAutopromoteOnceGroups( $event ) {
1640 global $wgAutopromoteOnceLogInRC;
1642 if ( wfReadOnly() ||
!$this->getId() ) {
1646 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1647 if ( $toPromote === [] ) {
1651 if ( !$this->checkAndSetTouched() ) {
1652 return []; // raced out (bug T48834)
1655 $oldGroups = $this->getGroups(); // previous groups
1656 $oldUGMs = $this->getGroupMemberships();
1657 foreach ( $toPromote as $group ) {
1658 $this->addGroup( $group );
1660 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1661 $newUGMs = $this->getGroupMemberships();
1663 // update groups in external authentication database
1664 Hooks
::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
1666 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1667 $logEntry->setPerformer( $this );
1668 $logEntry->setTarget( $this->getUserPage() );
1669 $logEntry->setParameters( [
1670 '4::oldgroups' => $oldGroups,
1671 '5::newgroups' => $newGroups,
1673 $logid = $logEntry->insert();
1674 if ( $wgAutopromoteOnceLogInRC ) {
1675 $logEntry->publish( $logid );
1682 * Builds update conditions. Additional conditions may be added to $conditions to
1683 * protected against race conditions using a compare-and-set (CAS) mechanism
1684 * based on comparing $this->mTouched with the user_touched field.
1686 * @param Database $db
1687 * @param array $conditions WHERE conditions for use with Database::update
1688 * @return array WHERE conditions for use with Database::update
1690 protected function makeUpdateConditions( Database
$db, array $conditions ) {
1691 if ( $this->mTouched
) {
1692 // CAS check: only update if the row wasn't changed sicne it was loaded.
1693 $conditions['user_touched'] = $db->timestamp( $this->mTouched
);
1700 * Bump user_touched if it didn't change since this object was loaded
1702 * On success, the mTouched field is updated.
1703 * The user serialization cache is always cleared.
1705 * @return bool Whether user_touched was actually updated
1708 protected function checkAndSetTouched() {
1711 if ( !$this->mId
) {
1712 return false; // anon
1715 // Get a new user_touched that is higher than the old one
1716 $newTouched = $this->newTouchedTimestamp();
1718 $dbw = wfGetDB( DB_MASTER
);
1719 $dbw->update( 'user',
1720 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1721 $this->makeUpdateConditions( $dbw, [
1722 'user_id' => $this->mId
,
1726 $success = ( $dbw->affectedRows() > 0 );
1729 $this->mTouched
= $newTouched;
1730 $this->clearSharedCache();
1732 // Clears on failure too since that is desired if the cache is stale
1733 $this->clearSharedCache( 'refresh' );
1740 * Clear various cached data stored in this object. The cache of the user table
1741 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1743 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1744 * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
1746 public function clearInstanceCache( $reloadFrom = false ) {
1747 $this->mNewtalk
= -1;
1748 $this->mDatePreference
= null;
1749 $this->mBlockedby
= -1; # Unset
1750 $this->mHash
= false;
1751 $this->mRights
= null;
1752 $this->mEffectiveGroups
= null;
1753 $this->mImplicitGroups
= null;
1754 $this->mGroupMemberships
= null;
1755 $this->mOptions
= null;
1756 $this->mOptionsLoaded
= false;
1757 $this->mEditCount
= null;
1759 if ( $reloadFrom ) {
1760 $this->mLoadedItems
= [];
1761 $this->mFrom
= $reloadFrom;
1766 * Combine the language default options with any site-specific options
1767 * and add the default language variants.
1769 * @return array Array of String options
1771 public static function getDefaultOptions() {
1772 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
1774 static $defOpt = null;
1775 static $defOptLang = null;
1777 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1778 if ( $defOpt !== null && $defOptLang === $contLang->getCode() ) {
1779 // The content language does not change (and should not change) mid-request, but the
1780 // unit tests change it anyway, and expect this method to return values relevant to the
1781 // current content language.
1785 $defOpt = $wgDefaultUserOptions;
1786 // Default language setting
1787 $defOptLang = $contLang->getCode();
1788 $defOpt['language'] = $defOptLang;
1789 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1790 if ( $langCode === $contLang->getCode() ) {
1791 $defOpt['variant'] = $langCode;
1793 $defOpt["variant-$langCode"] = $langCode;
1797 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1798 // since extensions may change the set of searchable namespaces depending
1799 // on user groups/permissions.
1800 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1801 $defOpt['searchNs' . $nsnum] = (bool)$val;
1803 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1805 Hooks
::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1811 * Get a given default option value.
1813 * @param string $opt Name of option to retrieve
1814 * @return string Default option value
1816 public static function getDefaultOption( $opt ) {
1817 $defOpts = self
::getDefaultOptions();
1818 return $defOpts[$opt] ??
null;
1822 * Get blocking information
1823 * @param bool $fromReplica Whether to check the replica DB first.
1824 * To improve performance, non-critical checks are done against replica DBs.
1825 * Check when actually saving should be done against master.
1827 private function getBlockedStatus( $fromReplica = true ) {
1828 global $wgProxyWhitelist, $wgApplyIpBlocksToXff, $wgSoftBlockRanges;
1830 if ( $this->mBlockedby
!= -1 ) {
1834 wfDebug( __METHOD__
. ": checking...\n" );
1836 // Initialize data...
1837 // Otherwise something ends up stomping on $this->mBlockedby when
1838 // things get lazy-loaded later, causing false positive block hits
1839 // due to -1 !== 0. Probably session-related... Nothing should be
1840 // overwriting mBlockedby, surely?
1843 # We only need to worry about passing the IP address to the Block generator if the
1844 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1845 # know which IP address they're actually coming from
1847 $sessionUser = RequestContext
::getMain()->getUser();
1848 // the session user is set up towards the end of Setup.php. Until then,
1849 // assume it's a logged-out user.
1850 $globalUserName = $sessionUser->isSafeToLoad()
1851 ?
$sessionUser->getName()
1852 : IP
::sanitizeIP( $sessionUser->getRequest()->getIP() );
1853 if ( $this->getName() === $globalUserName && !$this->isAllowed( 'ipblock-exempt' ) ) {
1854 $ip = $this->getRequest()->getIP();
1858 $block = Block
::newFromTarget( $this, $ip, !$fromReplica );
1861 if ( !$block instanceof Block
) {
1862 $block = $this->getBlockFromCookieValue( $this->getRequest()->getCookie( 'BlockID' ) );
1866 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1868 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1869 $block = new Block( [
1870 'byText' => wfMessage( 'proxyblocker' )->text(),
1871 'reason' => wfMessage( 'proxyblockreason' )->plain(),
1873 'systemBlock' => 'proxy',
1875 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1876 $block = new Block( [
1877 'byText' => wfMessage( 'sorbs' )->text(),
1878 'reason' => wfMessage( 'sorbsreason' )->plain(),
1880 'systemBlock' => 'dnsbl',
1885 // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
1886 if ( !$block instanceof Block
1887 && $wgApplyIpBlocksToXff
1889 && !in_array( $ip, $wgProxyWhitelist )
1891 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1892 $xff = array_map( 'trim', explode( ',', $xff ) );
1893 $xff = array_diff( $xff, [ $ip ] );
1894 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$fromReplica );
1895 $block = Block
::chooseBlock( $xffblocks, $xff );
1896 if ( $block instanceof Block
) {
1897 # Mangle the reason to alert the user that the block
1898 # originated from matching the X-Forwarded-For header.
1899 $block->setReason( wfMessage( 'xffblockreason', $block->getReason() )->plain() );
1903 if ( !$block instanceof Block
1906 && IP
::isInRanges( $ip, $wgSoftBlockRanges )
1908 $block = new Block( [
1910 'byText' => 'MediaWiki default',
1911 'reason' => wfMessage( 'softblockrangesreason', $ip )->plain(),
1913 'systemBlock' => 'wgSoftBlockRanges',
1917 if ( $block instanceof Block
) {
1918 wfDebug( __METHOD__
. ": Found block.\n" );
1919 $this->mBlock
= $block;
1920 $this->mBlockedby
= $block->getByName();
1921 $this->mBlockreason
= $block->getReason();
1922 $this->mHideName
= $block->getHideName();
1923 $this->mAllowUsertalk
= $block->isUsertalkEditAllowed();
1925 $this->mBlock
= null;
1926 $this->mBlockedby
= '';
1927 $this->mBlockreason
= '';
1928 $this->mHideName
= 0;
1929 $this->mAllowUsertalk
= false;
1932 // Avoid PHP 7.1 warning of passing $this by reference
1935 Hooks
::run( 'GetBlockedStatus', [ &$thisUser ] );
1939 * Try to load a Block from an ID given in a cookie value.
1940 * @param string|null $blockCookieVal The cookie value to check.
1941 * @return Block|bool The Block object, or false if none could be loaded.
1943 protected function getBlockFromCookieValue( $blockCookieVal ) {
1944 // Make sure there's something to check. The cookie value must start with a number.
1945 if ( strlen( $blockCookieVal ) < 1 ||
!is_numeric( substr( $blockCookieVal, 0, 1 ) ) ) {
1948 // Load the Block from the ID in the cookie.
1949 $blockCookieId = Block
::getIdFromCookieValue( $blockCookieVal );
1950 if ( $blockCookieId !== null ) {
1951 // An ID was found in the cookie.
1952 $tmpBlock = Block
::newFromID( $blockCookieId );
1953 if ( $tmpBlock instanceof Block
) {
1954 $config = RequestContext
::getMain()->getConfig();
1956 switch ( $tmpBlock->getType() ) {
1957 case Block
::TYPE_USER
:
1958 $blockIsValid = !$tmpBlock->isExpired() && $tmpBlock->isAutoblocking();
1959 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1961 case Block
::TYPE_IP
:
1962 case Block
::TYPE_RANGE
:
1963 // If block is type IP or IP range, load only if user is not logged in (T152462)
1964 $blockIsValid = !$tmpBlock->isExpired() && !$this->isLoggedIn();
1965 $useBlockCookie = ( $config->get( 'CookieSetOnIpBlock' ) === true );
1968 $blockIsValid = false;
1969 $useBlockCookie = false;
1972 if ( $blockIsValid && $useBlockCookie ) {
1977 // If the block is not valid, remove the cookie.
1978 Block
::clearCookie( $this->getRequest()->response() );
1980 // If the block doesn't exist, remove the cookie.
1981 Block
::clearCookie( $this->getRequest()->response() );
1988 * Whether the given IP is in a DNS blacklist.
1990 * @param string $ip IP to check
1991 * @param bool $checkWhitelist Whether to check the whitelist first
1992 * @return bool True if blacklisted.
1994 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1995 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1997 if ( !$wgEnableDnsBlacklist ||
1998 ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
2003 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
2007 * Whether the given IP is in a given DNS blacklist.
2009 * @param string $ip IP to check
2010 * @param string|array $bases Array of Strings: URL of the DNS blacklist
2011 * @return bool True if blacklisted.
2013 public function inDnsBlacklist( $ip, $bases ) {
2015 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
2016 if ( IP
::isIPv4( $ip ) ) {
2017 // Reverse IP, T23255
2018 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
2020 foreach ( (array)$bases as $base ) {
2022 // If we have an access key, use that too (ProjectHoneypot, etc.)
2024 if ( is_array( $base ) ) {
2025 if ( count( $base ) >= 2 ) {
2026 // Access key is 1, base URL is 0
2027 $host = "{$base[1]}.$ipReversed.{$base[0]}";
2029 $host = "$ipReversed.{$base[0]}";
2031 $basename = $base[0];
2033 $host = "$ipReversed.$base";
2037 $ipList = gethostbynamel( $host );
2040 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
2045 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
2053 * Check if an IP address is in the local proxy list
2059 public static function isLocallyBlockedProxy( $ip ) {
2060 global $wgProxyList;
2062 if ( !$wgProxyList ) {
2066 if ( !is_array( $wgProxyList ) ) {
2067 // Load values from the specified file
2068 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
2071 $resultProxyList = [];
2072 $deprecatedIPEntries = [];
2074 // backward compatibility: move all ip addresses in keys to values
2075 foreach ( $wgProxyList as $key => $value ) {
2076 $keyIsIP = IP
::isIPAddress( $key );
2077 $valueIsIP = IP
::isIPAddress( $value );
2078 if ( $keyIsIP && !$valueIsIP ) {
2079 $deprecatedIPEntries[] = $key;
2080 $resultProxyList[] = $key;
2081 } elseif ( $keyIsIP && $valueIsIP ) {
2082 $deprecatedIPEntries[] = $key;
2083 $resultProxyList[] = $key;
2084 $resultProxyList[] = $value;
2086 $resultProxyList[] = $value;
2090 if ( $deprecatedIPEntries ) {
2092 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
2093 implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
2096 $proxyListIPSet = new IPSet( $resultProxyList );
2097 return $proxyListIPSet->match( $ip );
2101 * Is this user subject to rate limiting?
2103 * @return bool True if rate limited
2105 public function isPingLimitable() {
2106 global $wgRateLimitsExcludedIPs;
2107 if ( IP
::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
2108 // No other good way currently to disable rate limits
2109 // for specific IPs. :P
2110 // But this is a crappy hack and should die.
2113 return !$this->isAllowed( 'noratelimit' );
2117 * Primitive rate limits: enforce maximum actions per time period
2118 * to put a brake on flooding.
2120 * The method generates both a generic profiling point and a per action one
2121 * (suffix being "-$action".
2123 * @note When using a shared cache like memcached, IP-address
2124 * last-hit counters will be shared across wikis.
2126 * @param string $action Action to enforce; 'edit' if unspecified
2127 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
2128 * @return bool True if a rate limiter was tripped
2130 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
2131 // Avoid PHP 7.1 warning of passing $this by reference
2133 // Call the 'PingLimiter' hook
2135 if ( !Hooks
::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
2139 global $wgRateLimits;
2140 if ( !isset( $wgRateLimits[$action] ) ) {
2144 $limits = array_merge(
2145 [ '&can-bypass' => true ],
2146 $wgRateLimits[$action]
2149 // Some groups shouldn't trigger the ping limiter, ever
2150 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
2155 $id = $this->getId();
2157 $isNewbie = $this->isNewbie();
2158 $cache = ObjectCache
::getLocalClusterInstance();
2162 if ( isset( $limits['anon'] ) ) {
2163 $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
2165 } elseif ( isset( $limits['user'] ) ) {
2166 // limits for logged-in users
2167 $userLimit = $limits['user'];
2170 // limits for anons and for newbie logged-in users
2173 if ( isset( $limits['ip'] ) ) {
2174 $ip = $this->getRequest()->getIP();
2175 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
2177 // subnet-based limits
2178 if ( isset( $limits['subnet'] ) ) {
2179 $ip = $this->getRequest()->getIP();
2180 $subnet = IP
::getSubnet( $ip );
2181 if ( $subnet !== false ) {
2182 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
2187 // Check for group-specific permissions
2188 // If more than one group applies, use the group with the highest limit ratio (max/period)
2189 foreach ( $this->getGroups() as $group ) {
2190 if ( isset( $limits[$group] ) ) {
2191 if ( $userLimit === false
2192 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
2194 $userLimit = $limits[$group];
2199 // limits for newbie logged-in users (override all the normal user limits)
2200 if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
2201 $userLimit = $limits['newbie'];
2204 // Set the user limit key
2205 if ( $userLimit !== false ) {
2206 list( $max, $period ) = $userLimit;
2207 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
2208 $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
2211 // ip-based limits for all ping-limitable users
2212 if ( isset( $limits['ip-all'] ) ) {
2213 $ip = $this->getRequest()->getIP();
2214 // ignore if user limit is more permissive
2215 if ( $isNewbie ||
$userLimit === false
2216 ||
$limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
2217 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
2221 // subnet-based limits for all ping-limitable users
2222 if ( isset( $limits['subnet-all'] ) ) {
2223 $ip = $this->getRequest()->getIP();
2224 $subnet = IP
::getSubnet( $ip );
2225 if ( $subnet !== false ) {
2226 // ignore if user limit is more permissive
2227 if ( $isNewbie ||
$userLimit === false
2228 ||
$limits['ip-all'][0] / $limits['ip-all'][1]
2229 > $userLimit[0] / $userLimit[1] ) {
2230 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
2236 foreach ( $keys as $key => $limit ) {
2237 list( $max, $period ) = $limit;
2238 $summary = "(limit $max in {$period}s)";
2239 $count = $cache->get( $key );
2242 if ( $count >= $max ) {
2243 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
2244 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
2247 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
2250 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
2251 if ( $incrBy > 0 ) {
2252 $cache->add( $key, 0, intval( $period ) ); // first ping
2255 if ( $incrBy > 0 ) {
2256 $cache->incr( $key, $incrBy );
2264 * Check if user is blocked
2266 * @param bool $fromReplica Whether to check the replica DB instead of
2267 * the master. Hacked from false due to horrible probs on site.
2268 * @return bool True if blocked, false otherwise
2270 public function isBlocked( $fromReplica = true ) {
2271 return $this->getBlock( $fromReplica ) instanceof Block
&&
2272 $this->getBlock()->appliesToRight( 'edit' );
2276 * Get the block affecting the user, or null if the user is not blocked
2278 * @param bool $fromReplica Whether to check the replica DB instead of the master
2279 * @return Block|null
2281 public function getBlock( $fromReplica = true ) {
2282 $this->getBlockedStatus( $fromReplica );
2283 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
2287 * Check if user is blocked from editing a particular article
2289 * @param Title $title Title to check
2290 * @param bool $fromReplica Whether to check the replica DB instead of the master
2293 public function isBlockedFrom( $title, $fromReplica = false ) {
2294 $blocked = $this->isHidden();
2297 $block = $this->getBlock( $fromReplica );
2299 // Special handling for a user's own talk page. The block is not aware
2300 // of the user, so this must be done here.
2301 if ( $title->equals( $this->getTalkPage() ) ) {
2302 $blocked = $block->appliesToUsertalk( $title );
2304 $blocked = $block->appliesToTitle( $title );
2309 // only for the purpose of the hook. We really don't need this here.
2310 $allowUsertalk = $this->mAllowUsertalk
;
2312 Hooks
::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2318 * If user is blocked, return the name of the user who placed the block
2319 * @return string Name of blocker
2321 public function blockedBy() {
2322 $this->getBlockedStatus();
2323 return $this->mBlockedby
;
2327 * If user is blocked, return the specified reason for the block
2328 * @return string Blocking reason
2330 public function blockedFor() {
2331 $this->getBlockedStatus();
2332 return $this->mBlockreason
;
2336 * If user is blocked, return the ID for the block
2337 * @return int Block ID
2339 public function getBlockId() {
2340 $this->getBlockedStatus();
2341 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
2345 * Check if user is blocked on all wikis.
2346 * Do not use for actual edit permission checks!
2347 * This is intended for quick UI checks.
2349 * @param string $ip IP address, uses current client if none given
2350 * @return bool True if blocked, false otherwise
2352 public function isBlockedGlobally( $ip = '' ) {
2353 return $this->getGlobalBlock( $ip ) instanceof Block
;
2357 * Check if user is blocked on all wikis.
2358 * Do not use for actual edit permission checks!
2359 * This is intended for quick UI checks.
2361 * @param string $ip IP address, uses current client if none given
2362 * @return Block|null Block object if blocked, null otherwise
2363 * @throws FatalError
2364 * @throws MWException
2366 public function getGlobalBlock( $ip = '' ) {
2367 if ( $this->mGlobalBlock
!== null ) {
2368 return $this->mGlobalBlock ?
: null;
2370 // User is already an IP?
2371 if ( IP
::isIPAddress( $this->getName() ) ) {
2372 $ip = $this->getName();
2374 $ip = $this->getRequest()->getIP();
2376 // Avoid PHP 7.1 warning of passing $this by reference
2380 Hooks
::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
2382 if ( $blocked && $block === null ) {
2383 // back-compat: UserIsBlockedGlobally didn't have $block param first
2384 $block = new Block( [
2386 'systemBlock' => 'global-block'
2390 $this->mGlobalBlock
= $blocked ?
$block : false;
2391 return $this->mGlobalBlock ?
: null;
2395 * Check if user account is locked
2397 * @return bool True if locked, false otherwise
2399 public function isLocked() {
2400 if ( $this->mLocked
!== null ) {
2401 return $this->mLocked
;
2404 $this->mLocked
= false;
2405 Hooks
::run( 'UserIsLocked', [ $this, &$this->mLocked
] );
2406 return $this->mLocked
;
2410 * Check if user account is hidden
2412 * @return bool True if hidden, false otherwise
2414 public function isHidden() {
2415 if ( $this->mHideName
!== null ) {
2416 return (bool)$this->mHideName
;
2418 $this->getBlockedStatus();
2419 if ( !$this->mHideName
) {
2421 $this->mHideName
= false;
2422 Hooks
::run( 'UserIsHidden', [ $this, &$this->mHideName
] );
2424 return (bool)$this->mHideName
;
2428 * Get the user's ID.
2429 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2431 public function getId() {
2432 if ( $this->mId
=== null && $this->mName
!== null && self
::isIP( $this->mName
) ) {
2433 // Special case, we know the user is anonymous
2437 if ( !$this->isItemLoaded( 'id' ) ) {
2438 // Don't load if this was initialized from an ID
2442 return (int)$this->mId
;
2446 * Set the user and reload all fields according to a given ID
2447 * @param int $v User ID to reload
2449 public function setId( $v ) {
2451 $this->clearInstanceCache( 'id' );
2455 * Get the user name, or the IP of an anonymous user
2456 * @return string User's name or IP address
2458 public function getName() {
2459 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2460 // Special case optimisation
2461 return $this->mName
;
2465 if ( $this->mName
=== false ) {
2467 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2470 return $this->mName
;
2474 * Set the user name.
2476 * This does not reload fields from the database according to the given
2477 * name. Rather, it is used to create a temporary "nonexistent user" for
2478 * later addition to the database. It can also be used to set the IP
2479 * address for an anonymous user to something other than the current
2482 * @note User::newFromName() has roughly the same function, when the named user
2484 * @param string $str New user name to set
2486 public function setName( $str ) {
2488 $this->mName
= $str;
2492 * Get the user's actor ID.
2494 * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
2495 * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
2497 public function getActorId( IDatabase
$dbw = null ) {
2498 global $wgActorTableSchemaMigrationStage;
2500 // Technically we should always return 0 without SCHEMA_COMPAT_READ_NEW,
2501 // but it does little harm and might be needed for write callers loading a User.
2502 if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) ) {
2506 if ( !$this->isItemLoaded( 'actor' ) ) {
2510 // Currently $this->mActorId might be null if $this was loaded from a
2511 // cache entry that was written when $wgActorTableSchemaMigrationStage
2512 // was SCHEMA_COMPAT_OLD. Once that is no longer a possibility (i.e. when
2513 // User::VERSION is incremented after $wgActorTableSchemaMigrationStage
2514 // has been removed), that condition may be removed.
2515 if ( $this->mActorId
=== null ||
!$this->mActorId
&& $dbw ) {
2517 'actor_user' => $this->getId() ?
: null,
2518 'actor_name' => (string)$this->getName(),
2521 if ( $q['actor_user'] === null && self
::isUsableName( $q['actor_name'] ) ) {
2522 throw new CannotCreateActorException(
2523 'Cannot create an actor for a usable name that is not an existing user'
2526 if ( $q['actor_name'] === '' ) {
2527 throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
2529 $dbw->insert( 'actor', $q, __METHOD__
, [ 'IGNORE' ] );
2530 if ( $dbw->affectedRows() ) {
2531 $this->mActorId
= (int)$dbw->insertId();
2534 // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
2535 $this->mActorId
= (int)$dbw->selectField(
2540 [ 'LOCK IN SHARE MODE' ]
2542 if ( !$this->mActorId
) {
2543 throw new CannotCreateActorException(
2544 "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
2548 $this->invalidateCache();
2550 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $this->queryFlagsUsed
);
2551 $db = wfGetDB( $index );
2552 $this->mActorId
= (int)$db->selectField( 'actor', 'actor_id', $q, __METHOD__
, $options );
2554 $this->setItemLoaded( 'actor' );
2557 return (int)$this->mActorId
;
2561 * Get the user's name escaped by underscores.
2562 * @return string Username escaped by underscores.
2564 public function getTitleKey() {
2565 return str_replace( ' ', '_', $this->getName() );
2569 * Check if the user has new messages.
2570 * @return bool True if the user has new messages
2572 public function getNewtalk() {
2575 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2576 if ( $this->mNewtalk
=== -1 ) {
2577 $this->mNewtalk
= false; # reset talk page status
2579 // Check memcached separately for anons, who have no
2580 // entire User object stored in there.
2581 if ( !$this->mId
) {
2582 global $wgDisableAnonTalk;
2583 if ( $wgDisableAnonTalk ) {
2584 // Anon newtalk disabled by configuration.
2585 $this->mNewtalk
= false;
2587 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2590 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2594 return (bool)$this->mNewtalk
;
2598 * Return the data needed to construct links for new talk page message
2599 * alerts. If there are new messages, this will return an associative array
2600 * with the following data:
2601 * wiki: The database name of the wiki
2602 * link: Root-relative link to the user's talk page
2603 * rev: The last talk page revision that the user has seen or null. This
2604 * is useful for building diff links.
2605 * If there are no new messages, it returns an empty array.
2606 * @note This function was designed to accomodate multiple talk pages, but
2607 * currently only returns a single link and revision.
2610 public function getNewMessageLinks() {
2611 // Avoid PHP 7.1 warning of passing $this by reference
2614 if ( !Hooks
::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
2618 if ( !$this->getNewtalk() ) {
2621 $utp = $this->getTalkPage();
2622 $dbr = wfGetDB( DB_REPLICA
);
2623 // Get the "last viewed rev" timestamp from the oldest message notification
2624 $timestamp = $dbr->selectField( 'user_newtalk',
2625 'MIN(user_last_timestamp)',
2626 $this->isAnon() ?
[ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2628 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2631 'wiki' => WikiMap
::getWikiIdFromDbDomain( WikiMap
::getCurrentWikiDbDomain() ),
2632 'link' => $utp->getLocalURL(),
2639 * Get the revision ID for the last talk page revision viewed by the talk
2641 * @return int|null Revision ID or null
2643 public function getNewMessageRevisionId() {
2644 $newMessageRevisionId = null;
2645 $newMessageLinks = $this->getNewMessageLinks();
2647 // Note: getNewMessageLinks() never returns more than a single link
2648 // and it is always for the same wiki, but we double-check here in
2649 // case that changes some time in the future.
2650 if ( $newMessageLinks && count( $newMessageLinks ) === 1
2651 && WikiMap
::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
2652 && $newMessageLinks[0]['rev']
2654 /** @var Revision $newMessageRevision */
2655 $newMessageRevision = $newMessageLinks[0]['rev'];
2656 $newMessageRevisionId = $newMessageRevision->getId();
2659 return $newMessageRevisionId;
2663 * Internal uncached check for new messages
2666 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2667 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2668 * @return bool True if the user has new messages
2670 protected function checkNewtalk( $field, $id ) {
2671 $dbr = wfGetDB( DB_REPLICA
);
2673 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__
);
2675 return $ok !== false;
2679 * Add or update the new messages flag
2680 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2681 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2682 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2683 * @return bool True if successful, false otherwise
2685 protected function updateNewtalk( $field, $id, $curRev = null ) {
2686 // Get timestamp of the talk page revision prior to the current one
2687 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2688 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2689 // Mark the user as having new messages since this revision
2690 $dbw = wfGetDB( DB_MASTER
);
2691 $dbw->insert( 'user_newtalk',
2692 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2695 if ( $dbw->affectedRows() ) {
2696 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2700 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2705 * Clear the new messages flag for the given user
2706 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2707 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2708 * @return bool True if successful, false otherwise
2710 protected function deleteNewtalk( $field, $id ) {
2711 $dbw = wfGetDB( DB_MASTER
);
2712 $dbw->delete( 'user_newtalk',
2715 if ( $dbw->affectedRows() ) {
2716 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2720 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2725 * Update the 'You have new messages!' status.
2726 * @param bool $val Whether the user has new messages
2727 * @param Revision|null $curRev New, as yet unseen revision of the user talk
2728 * page. Ignored if null or !$val.
2730 public function setNewtalk( $val, $curRev = null ) {
2731 if ( wfReadOnly() ) {
2736 $this->mNewtalk
= $val;
2738 if ( $this->isAnon() ) {
2740 $id = $this->getName();
2743 $id = $this->getId();
2747 $changed = $this->updateNewtalk( $field, $id, $curRev );
2749 $changed = $this->deleteNewtalk( $field, $id );
2753 $this->invalidateCache();
2758 * Generate a current or new-future timestamp to be stored in the
2759 * user_touched field when we update things.
2761 * @return string Timestamp in TS_MW format
2763 private function newTouchedTimestamp() {
2765 if ( $this->mTouched
) {
2766 $time = max( $time, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2769 return wfTimestamp( TS_MW
, $time );
2773 * Clear user data from memcached
2775 * Use after applying updates to the database; caller's
2776 * responsibility to update user_touched if appropriate.
2778 * Called implicitly from invalidateCache() and saveSettings().
2780 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2782 public function clearSharedCache( $mode = 'changed' ) {
2783 if ( !$this->getId() ) {
2787 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2788 $key = $this->getCacheKey( $cache );
2789 if ( $mode === 'refresh' ) {
2790 $cache->delete( $key, 1 );
2792 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2793 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2794 $lb->getConnection( DB_MASTER
)->onTransactionPreCommitOrIdle(
2795 function () use ( $cache, $key ) {
2796 $cache->delete( $key );
2801 $cache->delete( $key );
2807 * Immediately touch the user data cache for this account
2809 * Calls touch() and removes account data from memcached
2811 public function invalidateCache() {
2813 $this->clearSharedCache();
2817 * Update the "touched" timestamp for the user
2819 * This is useful on various login/logout events when making sure that
2820 * a browser or proxy that has multiple tenants does not suffer cache
2821 * pollution where the new user sees the old users content. The value
2822 * of getTouched() is checked when determining 304 vs 200 responses.
2823 * Unlike invalidateCache(), this preserves the User object cache and
2824 * avoids database writes.
2828 public function touch() {
2829 $id = $this->getId();
2831 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2832 $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
2833 $cache->touchCheckKey( $key );
2834 $this->mQuickTouched
= null;
2839 * Validate the cache for this account.
2840 * @param string $timestamp A timestamp in TS_MW format
2843 public function validateCache( $timestamp ) {
2844 return ( $timestamp >= $this->getTouched() );
2848 * Get the user touched timestamp
2850 * Use this value only to validate caches via inequalities
2851 * such as in the case of HTTP If-Modified-Since response logic
2853 * @return string TS_MW Timestamp
2855 public function getTouched() {
2859 if ( $this->mQuickTouched
=== null ) {
2860 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2861 $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId
);
2863 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2866 return max( $this->mTouched
, $this->mQuickTouched
);
2869 return $this->mTouched
;
2873 * Get the user_touched timestamp field (time of last DB updates)
2874 * @return string TS_MW Timestamp
2877 public function getDBTouched() {
2880 return $this->mTouched
;
2884 * Set the password and reset the random token.
2885 * Calls through to authentication plugin if necessary;
2886 * will have no effect if the auth plugin refuses to
2887 * pass the change through or if the legal password
2890 * As a special case, setting the password to null
2891 * wipes it, so the account cannot be logged in until
2892 * a new password is set, for instance via e-mail.
2894 * @deprecated since 1.27, use AuthManager instead
2895 * @param string $str New password to set
2896 * @throws PasswordError On failure
2899 public function setPassword( $str ) {
2900 wfDeprecated( __METHOD__
, '1.27' );
2901 return $this->setPasswordInternal( $str );
2905 * Set the password and reset the random token unconditionally.
2907 * @deprecated since 1.27, use AuthManager instead
2908 * @param string|null $str New password to set or null to set an invalid
2909 * password hash meaning that the user will not be able to log in
2910 * through the web interface.
2912 public function setInternalPassword( $str ) {
2913 wfDeprecated( __METHOD__
, '1.27' );
2914 $this->setPasswordInternal( $str );
2918 * Actually set the password and such
2919 * @since 1.27 cannot set a password for a user not in the database
2920 * @param string|null $str New password to set or null to set an invalid
2921 * password hash meaning that the user will not be able to log in
2922 * through the web interface.
2923 * @return bool Success
2925 private function setPasswordInternal( $str ) {
2926 $manager = AuthManager
::singleton();
2928 // If the user doesn't exist yet, fail
2929 if ( !$manager->userExists( $this->getName() ) ) {
2930 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2933 $status = $this->changeAuthenticationData( [
2934 'username' => $this->getName(),
2938 if ( !$status->isGood() ) {
2939 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
2940 ->info( __METHOD__
. ': Password change rejected: '
2941 . $status->getWikiText( null, null, 'en' ) );
2945 $this->setOption( 'watchlisttoken', false );
2946 SessionManager
::singleton()->invalidateSessionsForUser( $this );
2952 * Changes credentials of the user.
2954 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2955 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2956 * e.g. when no provider handled the change.
2958 * @param array $data A set of authentication data in fieldname => value format. This is the
2959 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2963 public function changeAuthenticationData( array $data ) {
2964 $manager = AuthManager
::singleton();
2965 $reqs = $manager->getAuthenticationRequests( AuthManager
::ACTION_CHANGE
, $this );
2966 $reqs = AuthenticationRequest
::loadRequestsFromSubmission( $reqs, $data );
2968 $status = Status
::newGood( 'ignored' );
2969 foreach ( $reqs as $req ) {
2970 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2972 if ( $status->getValue() === 'ignored' ) {
2973 $status->warning( 'authenticationdatachange-ignored' );
2976 if ( $status->isGood() ) {
2977 foreach ( $reqs as $req ) {
2978 $manager->changeAuthenticationData( $req );
2985 * Get the user's current token.
2986 * @param bool $forceCreation Force the generation of a new token if the
2987 * user doesn't have one (default=true for backwards compatibility).
2988 * @return string|null Token
2990 public function getToken( $forceCreation = true ) {
2991 global $wgAuthenticationTokenVersion;
2994 if ( !$this->mToken
&& $forceCreation ) {
2998 if ( !$this->mToken
) {
2999 // The user doesn't have a token, return null to indicate that.
3003 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3004 // We return a random value here so existing token checks are very
3006 return MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3009 if ( $wgAuthenticationTokenVersion === null ) {
3010 // $wgAuthenticationTokenVersion not in use, so return the raw secret
3011 return $this->mToken
;
3014 // $wgAuthenticationTokenVersion in use, so hmac it.
3015 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
3017 // The raw hash can be overly long. Shorten it up.
3018 $len = max( 32, self
::TOKEN_LENGTH
);
3019 if ( strlen( $ret ) < $len ) {
3020 // Should never happen, even md5 is 128 bits
3021 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
3024 return substr( $ret, -$len );
3028 * Set the random token (used for persistent authentication)
3029 * Called from loadDefaults() among other places.
3031 * @param string|bool $token If specified, set the token to this value
3033 public function setToken( $token = false ) {
3035 if ( $this->mToken
=== self
::INVALID_TOKEN
) {
3036 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3037 ->debug( __METHOD__
. ": Ignoring attempt to set token for system user \"$this\"" );
3038 } elseif ( !$token ) {
3039 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
3041 $this->mToken
= $token;
3046 * Set the password for a password reminder or new account email
3048 * @deprecated Removed in 1.27. Use PasswordReset instead.
3049 * @param string $str New password to set or null to set an invalid
3050 * password hash meaning that the user will not be able to use it
3051 * @param bool $throttle If true, reset the throttle timestamp to the present
3053 public function setNewpassword( $str, $throttle = true ) {
3054 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
3058 * Get the user's e-mail address
3059 * @return string User's email address
3061 public function getEmail() {
3063 Hooks
::run( 'UserGetEmail', [ $this, &$this->mEmail
] );
3064 return $this->mEmail
;
3068 * Get the timestamp of the user's e-mail authentication
3069 * @return string TS_MW timestamp
3071 public function getEmailAuthenticationTimestamp() {
3073 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
3074 return $this->mEmailAuthenticated
;
3078 * Set the user's e-mail address
3079 * @param string $str New e-mail address
3081 public function setEmail( $str ) {
3083 if ( $str == $this->mEmail
) {
3086 $this->invalidateEmail();
3087 $this->mEmail
= $str;
3088 Hooks
::run( 'UserSetEmail', [ $this, &$this->mEmail
] );
3092 * Set the user's e-mail address and a confirmation mail if needed.
3095 * @param string $str New e-mail address
3098 public function setEmailWithConfirmation( $str ) {
3099 global $wgEnableEmail, $wgEmailAuthentication;
3101 if ( !$wgEnableEmail ) {
3102 return Status
::newFatal( 'emaildisabled' );
3105 $oldaddr = $this->getEmail();
3106 if ( $str === $oldaddr ) {
3107 return Status
::newGood( true );
3110 $type = $oldaddr != '' ?
'changed' : 'set';
3111 $notificationResult = null;
3113 if ( $wgEmailAuthentication && $type === 'changed' ) {
3114 // Send the user an email notifying the user of the change in registered
3115 // email address on their previous email address
3116 $change = $str != '' ?
'changed' : 'removed';
3117 $notificationResult = $this->sendMail(
3118 wfMessage( 'notificationemail_subject_' . $change )->text(),
3119 wfMessage( 'notificationemail_body_' . $change,
3120 $this->getRequest()->getIP(),
3126 $this->setEmail( $str );
3128 if ( $str !== '' && $wgEmailAuthentication ) {
3129 // Send a confirmation request to the new address if needed
3130 $result = $this->sendConfirmationMail( $type );
3132 if ( $notificationResult !== null ) {
3133 $result->merge( $notificationResult );
3136 if ( $result->isGood() ) {
3137 // Say to the caller that a confirmation and notification mail has been sent
3138 $result->value
= 'eauth';
3141 $result = Status
::newGood( true );
3148 * Get the user's real name
3149 * @return string User's real name
3151 public function getRealName() {
3152 if ( !$this->isItemLoaded( 'realname' ) ) {
3156 return $this->mRealName
;
3160 * Set the user's real name
3161 * @param string $str New real name
3163 public function setRealName( $str ) {
3165 $this->mRealName
= $str;
3169 * Get the user's current setting for a given option.
3171 * @param string $oname The option to check
3172 * @param string|array|null $defaultOverride A default value returned if the option does not exist
3173 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
3174 * @return string|array|int|null User's current value for the option
3175 * @see getBoolOption()
3176 * @see getIntOption()
3178 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
3179 global $wgHiddenPrefs;
3180 $this->loadOptions();
3182 # We want 'disabled' preferences to always behave as the default value for
3183 # users, even if they have set the option explicitly in their settings (ie they
3184 # set it, and then it was disabled removing their ability to change it). But
3185 # we don't want to erase the preferences in the database in case the preference
3186 # is re-enabled again. So don't touch $mOptions, just override the returned value
3187 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
3188 return self
::getDefaultOption( $oname );
3191 if ( array_key_exists( $oname, $this->mOptions
) ) {
3192 return $this->mOptions
[$oname];
3195 return $defaultOverride;
3199 * Get all user's options
3201 * @param int $flags Bitwise combination of:
3202 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
3203 * to the default value. (Since 1.25)
3206 public function getOptions( $flags = 0 ) {
3207 global $wgHiddenPrefs;
3208 $this->loadOptions();
3209 $options = $this->mOptions
;
3211 # We want 'disabled' preferences to always behave as the default value for
3212 # users, even if they have set the option explicitly in their settings (ie they
3213 # set it, and then it was disabled removing their ability to change it). But
3214 # we don't want to erase the preferences in the database in case the preference
3215 # is re-enabled again. So don't touch $mOptions, just override the returned value
3216 foreach ( $wgHiddenPrefs as $pref ) {
3217 $default = self
::getDefaultOption( $pref );
3218 if ( $default !== null ) {
3219 $options[$pref] = $default;
3223 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
3224 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
3231 * Get the user's current setting for a given option, as a boolean value.
3233 * @param string $oname The option to check
3234 * @return bool User's current value for the option
3237 public function getBoolOption( $oname ) {
3238 return (bool)$this->getOption( $oname );
3242 * Get the user's current setting for a given option, as an integer value.
3244 * @param string $oname The option to check
3245 * @param int $defaultOverride A default value returned if the option does not exist
3246 * @return int User's current value for the option
3249 public function getIntOption( $oname, $defaultOverride = 0 ) {
3250 $val = $this->getOption( $oname );
3252 $val = $defaultOverride;
3254 return intval( $val );
3258 * Set the given option for a user.
3260 * You need to call saveSettings() to actually write to the database.
3262 * @param string $oname The option to set
3263 * @param mixed $val New value to set
3265 public function setOption( $oname, $val ) {
3266 $this->loadOptions();
3268 // Explicitly NULL values should refer to defaults
3269 if ( is_null( $val ) ) {
3270 $val = self
::getDefaultOption( $oname );
3273 $this->mOptions
[$oname] = $val;
3277 * Get a token stored in the preferences (like the watchlist one),
3278 * resetting it if it's empty (and saving changes).
3280 * @param string $oname The option name to retrieve the token from
3281 * @return string|bool User's current value for the option, or false if this option is disabled.
3282 * @see resetTokenFromOption()
3284 * @deprecated since 1.26 Applications should use the OAuth extension
3286 public function getTokenFromOption( $oname ) {
3287 global $wgHiddenPrefs;
3289 $id = $this->getId();
3290 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
3294 $token = $this->getOption( $oname );
3296 // Default to a value based on the user token to avoid space
3297 // wasted on storing tokens for all users. When this option
3298 // is set manually by the user, only then is it stored.
3299 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
3306 * Reset a token stored in the preferences (like the watchlist one).
3307 * *Does not* save user's preferences (similarly to setOption()).
3309 * @param string $oname The option name to reset the token in
3310 * @return string|bool New token value, or false if this option is disabled.
3311 * @see getTokenFromOption()
3314 public function resetTokenFromOption( $oname ) {
3315 global $wgHiddenPrefs;
3316 if ( in_array( $oname, $wgHiddenPrefs ) ) {
3320 $token = MWCryptRand
::generateHex( 40 );
3321 $this->setOption( $oname, $token );
3326 * Return a list of the types of user options currently returned by
3327 * User::getOptionKinds().
3329 * Currently, the option kinds are:
3330 * - 'registered' - preferences which are registered in core MediaWiki or
3331 * by extensions using the UserGetDefaultOptions hook.
3332 * - 'registered-multiselect' - as above, using the 'multiselect' type.
3333 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
3334 * - 'userjs' - preferences with names starting with 'userjs-', intended to
3335 * be used by user scripts.
3336 * - 'special' - "preferences" that are not accessible via User::getOptions
3337 * or User::setOptions.
3338 * - 'unused' - preferences about which MediaWiki doesn't know anything.
3339 * These are usually legacy options, removed in newer versions.
3341 * The API (and possibly others) use this function to determine the possible
3342 * option types for validation purposes, so make sure to update this when a
3343 * new option kind is added.
3345 * @see User::getOptionKinds
3346 * @return array Option kinds
3348 public static function listOptionKinds() {
3351 'registered-multiselect',
3352 'registered-checkmatrix',
3360 * Return an associative array mapping preferences keys to the kind of a preference they're
3361 * used for. Different kinds are handled differently when setting or reading preferences.
3363 * See User::listOptionKinds for the list of valid option types that can be provided.
3365 * @see User::listOptionKinds
3366 * @param IContextSource $context
3367 * @param array|null $options Assoc. array with options keys to check as keys.
3368 * Defaults to $this->mOptions.
3369 * @return array The key => kind mapping data
3371 public function getOptionKinds( IContextSource
$context, $options = null ) {
3372 $this->loadOptions();
3373 if ( $options === null ) {
3374 $options = $this->mOptions
;
3377 $preferencesFactory = MediaWikiServices
::getInstance()->getPreferencesFactory();
3378 $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
3381 // Pull out the "special" options, so they don't get converted as
3382 // multiselect or checkmatrix.
3383 $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
3384 foreach ( $specialOptions as $name => $value ) {
3385 unset( $prefs[$name] );
3388 // Multiselect and checkmatrix options are stored in the database with
3389 // one key per option, each having a boolean value. Extract those keys.
3390 $multiselectOptions = [];
3391 foreach ( $prefs as $name => $info ) {
3392 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3393 ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField
::class ) ) {
3394 $opts = HTMLFormField
::flattenOptions( $info['options'] );
3395 $prefix = $info['prefix'] ??
$name;
3397 foreach ( $opts as $value ) {
3398 $multiselectOptions["$prefix$value"] = true;
3401 unset( $prefs[$name] );
3404 $checkmatrixOptions = [];
3405 foreach ( $prefs as $name => $info ) {
3406 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3407 ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix
::class ) ) {
3408 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
3409 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
3410 $prefix = $info['prefix'] ??
$name;
3412 foreach ( $columns as $column ) {
3413 foreach ( $rows as $row ) {
3414 $checkmatrixOptions["$prefix$column-$row"] = true;
3418 unset( $prefs[$name] );
3422 // $value is ignored
3423 foreach ( $options as $key => $value ) {
3424 if ( isset( $prefs[$key] ) ) {
3425 $mapping[$key] = 'registered';
3426 } elseif ( isset( $multiselectOptions[$key] ) ) {
3427 $mapping[$key] = 'registered-multiselect';
3428 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3429 $mapping[$key] = 'registered-checkmatrix';
3430 } elseif ( isset( $specialOptions[$key] ) ) {
3431 $mapping[$key] = 'special';
3432 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3433 $mapping[$key] = 'userjs';
3435 $mapping[$key] = 'unused';
3443 * Reset certain (or all) options to the site defaults
3445 * The optional parameter determines which kinds of preferences will be reset.
3446 * Supported values are everything that can be reported by getOptionKinds()
3447 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3449 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3450 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3451 * for backwards-compatibility.
3452 * @param IContextSource|null $context Context source used when $resetKinds
3453 * does not contain 'all', passed to getOptionKinds().
3454 * Defaults to RequestContext::getMain() when null.
3456 public function resetOptions(
3457 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3458 IContextSource
$context = null
3461 $defaultOptions = self
::getDefaultOptions();
3463 if ( !is_array( $resetKinds ) ) {
3464 $resetKinds = [ $resetKinds ];
3467 if ( in_array( 'all', $resetKinds ) ) {
3468 $newOptions = $defaultOptions;
3470 if ( $context === null ) {
3471 $context = RequestContext
::getMain();
3474 $optionKinds = $this->getOptionKinds( $context );
3475 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
3478 // Use default values for the options that should be deleted, and
3479 // copy old values for the ones that shouldn't.
3480 foreach ( $this->mOptions
as $key => $value ) {
3481 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3482 if ( array_key_exists( $key, $defaultOptions ) ) {
3483 $newOptions[$key] = $defaultOptions[$key];
3486 $newOptions[$key] = $value;
3491 Hooks
::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions
, $resetKinds ] );
3493 $this->mOptions
= $newOptions;
3494 $this->mOptionsLoaded
= true;
3498 * Get the user's preferred date format.
3499 * @return string User's preferred date format
3501 public function getDatePreference() {
3502 // Important migration for old data rows
3503 if ( is_null( $this->mDatePreference
) ) {
3505 $value = $this->getOption( 'date' );
3506 $map = $wgLang->getDatePreferenceMigrationMap();
3507 if ( isset( $map[$value] ) ) {
3508 $value = $map[$value];
3510 $this->mDatePreference
= $value;
3512 return $this->mDatePreference
;
3516 * Determine based on the wiki configuration and the user's options,
3517 * whether this user must be over HTTPS no matter what.
3521 public function requiresHTTPS() {
3522 global $wgSecureLogin;
3523 if ( !$wgSecureLogin ) {
3527 $https = $this->getBoolOption( 'prefershttps' );
3528 Hooks
::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3530 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3537 * Get the user preferred stub threshold
3541 public function getStubThreshold() {
3542 global $wgMaxArticleSize; # Maximum article size, in Kb
3543 $threshold = $this->getIntOption( 'stubthreshold' );
3544 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3545 // If they have set an impossible value, disable the preference
3546 // so we can use the parser cache again.
3553 * Get the permissions this user has.
3554 * @return string[] permission names
3556 public function getRights() {
3557 if ( is_null( $this->mRights
) ) {
3558 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3559 Hooks
::run( 'UserGetRights', [ $this, &$this->mRights
] );
3561 // Deny any rights denied by the user's session, unless this
3562 // endpoint has no sessions.
3563 if ( !defined( 'MW_NO_SESSION' ) ) {
3564 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3565 if ( $allowedRights !== null ) {
3566 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3570 Hooks
::run( 'UserGetRightsRemove', [ $this, &$this->mRights
] );
3571 // Force reindexation of rights when a hook has unset one of them
3572 $this->mRights
= array_values( array_unique( $this->mRights
) );
3574 // If block disables login, we should also remove any
3575 // extra rights blocked users might have, in case the
3576 // blocked user has a pre-existing session (T129738).
3577 // This is checked here for cases where people only call
3578 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3579 // to give a better error message in the common case.
3580 $config = RequestContext
::getMain()->getConfig();
3582 $this->isLoggedIn() &&
3583 $config->get( 'BlockDisablesLogin' ) &&
3587 $this->mRights
= array_intersect( $this->mRights
, $anon->getRights() );
3590 return $this->mRights
;
3594 * Get the list of explicit group memberships this user has.
3595 * The implicit * and user groups are not included.
3597 * @return string[] Array of internal group names (sorted since 1.33)
3599 public function getGroups() {
3601 $this->loadGroups();
3602 return array_keys( $this->mGroupMemberships
);
3606 * Get the list of explicit group memberships this user has, stored as
3607 * UserGroupMembership objects. Implicit groups are not included.
3609 * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
3612 public function getGroupMemberships() {
3614 $this->loadGroups();
3615 return $this->mGroupMemberships
;
3619 * Get the list of implicit group memberships this user has.
3620 * This includes all explicit groups, plus 'user' if logged in,
3621 * '*' for all accounts, and autopromoted groups
3622 * @param bool $recache Whether to avoid the cache
3623 * @return array Array of String internal group names
3625 public function getEffectiveGroups( $recache = false ) {
3626 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3627 $this->mEffectiveGroups
= array_unique( array_merge(
3628 $this->getGroups(), // explicit groups
3629 $this->getAutomaticGroups( $recache ) // implicit groups
3631 // Avoid PHP 7.1 warning of passing $this by reference
3633 // Hook for additional groups
3634 Hooks
::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups
] );
3635 // Force reindexation of groups when a hook has unset one of them
3636 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3638 return $this->mEffectiveGroups
;
3642 * Get the list of implicit group memberships this user has.
3643 * This includes 'user' if logged in, '*' for all accounts,
3644 * and autopromoted groups
3645 * @param bool $recache Whether to avoid the cache
3646 * @return array Array of String internal group names
3648 public function getAutomaticGroups( $recache = false ) {
3649 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3650 $this->mImplicitGroups
= [ '*' ];
3651 if ( $this->getId() ) {
3652 $this->mImplicitGroups
[] = 'user';
3654 $this->mImplicitGroups
= array_unique( array_merge(
3655 $this->mImplicitGroups
,
3656 Autopromote
::getAutopromoteGroups( $this )
3660 // Assure data consistency with rights/groups,
3661 // as getEffectiveGroups() depends on this function
3662 $this->mEffectiveGroups
= null;
3665 return $this->mImplicitGroups
;
3669 * Returns the groups the user has belonged to.
3671 * The user may still belong to the returned groups. Compare with getGroups().
3673 * The function will not return groups the user had belonged to before MW 1.17
3675 * @return array Names of the groups the user has belonged to.
3677 public function getFormerGroups() {
3680 if ( is_null( $this->mFormerGroups
) ) {
3681 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3682 ?
wfGetDB( DB_MASTER
)
3683 : wfGetDB( DB_REPLICA
);
3684 $res = $db->select( 'user_former_groups',
3686 [ 'ufg_user' => $this->mId
],
3688 $this->mFormerGroups
= [];
3689 foreach ( $res as $row ) {
3690 $this->mFormerGroups
[] = $row->ufg_group
;
3694 return $this->mFormerGroups
;
3698 * Get the user's edit count.
3699 * @return int|null Null for anonymous users
3701 public function getEditCount() {
3702 if ( !$this->getId() ) {
3706 if ( $this->mEditCount
=== null ) {
3707 /* Populate the count, if it has not been populated yet */
3708 $dbr = wfGetDB( DB_REPLICA
);
3709 // check if the user_editcount field has been initialized
3710 $count = $dbr->selectField(
3711 'user', 'user_editcount',
3712 [ 'user_id' => $this->mId
],
3716 if ( $count === null ) {
3717 // it has not been initialized. do so.
3718 $count = $this->initEditCountInternal();
3720 $this->mEditCount
= $count;
3722 return (int)$this->mEditCount
;
3726 * Add the user to the given group. This takes immediate effect.
3727 * If the user is already in the group, the expiry time will be updated to the new
3728 * expiry time. (If $expiry is omitted or null, the membership will be altered to
3731 * @param string $group Name of the group to add
3732 * @param string|null $expiry Optional expiry timestamp in any format acceptable to
3733 * wfTimestamp(), or null if the group assignment should not expire
3736 public function addGroup( $group, $expiry = null ) {
3738 $this->loadGroups();
3741 $expiry = wfTimestamp( TS_MW
, $expiry );
3744 if ( !Hooks
::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
3748 // create the new UserGroupMembership and put it in the DB
3749 $ugm = new UserGroupMembership( $this->mId
, $group, $expiry );
3750 if ( !$ugm->insert( true ) ) {
3754 $this->mGroupMemberships
[$group] = $ugm;
3756 // Refresh the groups caches, and clear the rights cache so it will be
3757 // refreshed on the next call to $this->getRights().
3758 $this->getEffectiveGroups( true );
3759 $this->mRights
= null;
3761 $this->invalidateCache();
3767 * Remove the user from the given group.
3768 * This takes immediate effect.
3769 * @param string $group Name of the group to remove
3772 public function removeGroup( $group ) {
3775 if ( !Hooks
::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3779 $ugm = UserGroupMembership
::getMembership( $this->mId
, $group );
3780 // delete the membership entry
3781 if ( !$ugm ||
!$ugm->delete() ) {
3785 $this->loadGroups();
3786 unset( $this->mGroupMemberships
[$group] );
3788 // Refresh the groups caches, and clear the rights cache so it will be
3789 // refreshed on the next call to $this->getRights().
3790 $this->getEffectiveGroups( true );
3791 $this->mRights
= null;
3793 $this->invalidateCache();
3799 * Get whether the user is logged in
3802 public function isLoggedIn() {
3803 return $this->getId() != 0;
3807 * Get whether the user is anonymous
3810 public function isAnon() {
3811 return !$this->isLoggedIn();
3815 * @return bool Whether this user is flagged as being a bot role account
3818 public function isBot() {
3819 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3824 Hooks
::run( "UserIsBot", [ $this, &$isBot ] );
3830 * Check if user is allowed to access a feature / make an action
3832 * @param string $permissions,... Permissions to test
3833 * @return bool True if user is allowed to perform *any* of the given actions
3835 public function isAllowedAny() {
3836 $permissions = func_get_args();
3837 foreach ( $permissions as $permission ) {
3838 if ( $this->isAllowed( $permission ) ) {
3847 * @param string $permissions,... Permissions to test
3848 * @return bool True if the user is allowed to perform *all* of the given actions
3850 public function isAllowedAll() {
3851 $permissions = func_get_args();
3852 foreach ( $permissions as $permission ) {
3853 if ( !$this->isAllowed( $permission ) ) {
3861 * Internal mechanics of testing a permission
3862 * @param string $action
3865 public function isAllowed( $action = '' ) {
3866 if ( $action === '' ) {
3867 return true; // In the spirit of DWIM
3869 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3870 // by misconfiguration: 0 == 'foo'
3871 return in_array( $action, $this->getRights(), true );
3875 * Check whether to enable recent changes patrol features for this user
3876 * @return bool True or false
3878 public function useRCPatrol() {
3879 global $wgUseRCPatrol;
3880 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3884 * Check whether to enable new pages patrol features for this user
3885 * @return bool True or false
3887 public function useNPPatrol() {
3888 global $wgUseRCPatrol, $wgUseNPPatrol;
3890 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3891 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3896 * Check whether to enable new files patrol features for this user
3897 * @return bool True or false
3899 public function useFilePatrol() {
3900 global $wgUseRCPatrol, $wgUseFilePatrol;
3902 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3903 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3908 * Get the WebRequest object to use with this object
3910 * @return WebRequest
3912 public function getRequest() {
3913 if ( $this->mRequest
) {
3914 return $this->mRequest
;
3922 * Check the watched status of an article.
3923 * @since 1.22 $checkRights parameter added
3924 * @param Title $title Title of the article to look at
3925 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3926 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3929 public function isWatched( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3930 if ( $title->isWatchable() && ( !$checkRights ||
$this->isAllowed( 'viewmywatchlist' ) ) ) {
3931 return MediaWikiServices
::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3938 * @since 1.22 $checkRights parameter added
3939 * @param Title $title Title of the article to look at
3940 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3941 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3943 public function addWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3944 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3945 MediaWikiServices
::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3947 [ $title->getSubjectPage(), $title->getTalkPage() ]
3950 $this->invalidateCache();
3954 * Stop watching an article.
3955 * @since 1.22 $checkRights parameter added
3956 * @param Title $title Title of the article to look at
3957 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3958 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3960 public function removeWatch( $title, $checkRights = self
::CHECK_USER_RIGHTS
) {
3961 if ( !$checkRights ||
$this->isAllowed( 'editmywatchlist' ) ) {
3962 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
3963 $store->removeWatch( $this, $title->getSubjectPage() );
3964 $store->removeWatch( $this, $title->getTalkPage() );
3966 $this->invalidateCache();
3970 * Clear the user's notification timestamp for the given title.
3971 * If e-notif e-mails are on, they will receive notification mails on
3972 * the next change of the page if it's watched etc.
3973 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3974 * @param Title &$title Title of the article to look at
3975 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3977 public function clearNotification( &$title, $oldid = 0 ) {
3978 global $wgUseEnotif, $wgShowUpdatedMarker;
3980 // Do nothing if the database is locked to writes
3981 if ( wfReadOnly() ) {
3985 // Do nothing if not allowed to edit the watchlist
3986 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3990 // If we're working on user's talk page, we should update the talk page message indicator
3991 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3992 // Avoid PHP 7.1 warning of passing $this by reference
3994 if ( !Hooks
::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
3998 // Try to update the DB post-send and only if needed...
3999 DeferredUpdates
::addCallableUpdate( function () use ( $title, $oldid ) {
4000 if ( !$this->getNewtalk() ) {
4001 return; // no notifications to clear
4004 // Delete the last notifications (they stack up)
4005 $this->setNewtalk( false );
4007 // If there is a new, unseen, revision, use its timestamp
4009 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
4012 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
4017 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4021 if ( $this->isAnon() ) {
4022 // Nothing else to do...
4026 // Only update the timestamp if the page is being watched.
4027 // The query to find out if it is watched is cached both in memcached and per-invocation,
4028 // and when it does have to be executed, it can be on a replica DB
4029 // If this is the user's newtalk page, we always update the timestamp
4031 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
4035 MediaWikiServices
::getInstance()->getWatchedItemStore()
4036 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
4040 * Resets all of the given user's page-change notification timestamps.
4041 * If e-notif e-mails are on, they will receive notification mails on
4042 * the next change of any watched page.
4043 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
4045 public function clearAllNotifications() {
4046 global $wgUseEnotif, $wgShowUpdatedMarker;
4047 // Do nothing if not allowed to edit the watchlist
4048 if ( wfReadOnly() ||
!$this->isAllowed( 'editmywatchlist' ) ) {
4052 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
4053 $this->setNewtalk( false );
4057 $id = $this->getId();
4062 $watchedItemStore = MediaWikiServices
::getInstance()->getWatchedItemStore();
4063 $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
4065 // We also need to clear here the "you have new message" notification for the own
4066 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
4070 * Compute experienced level based on edit count and registration date.
4072 * @return string 'newcomer', 'learner', or 'experienced'
4074 public function getExperienceLevel() {
4075 global $wgLearnerEdits,
4076 $wgExperiencedUserEdits,
4077 $wgLearnerMemberSince,
4078 $wgExperiencedUserMemberSince;
4080 if ( $this->isAnon() ) {
4084 $editCount = $this->getEditCount();
4085 $registration = $this->getRegistration();
4087 $learnerRegistration = wfTimestamp( TS_MW
, $now - $wgLearnerMemberSince * 86400 );
4088 $experiencedRegistration = wfTimestamp( TS_MW
, $now - $wgExperiencedUserMemberSince * 86400 );
4090 if ( $editCount < $wgLearnerEdits ||
4091 $registration > $learnerRegistration ) {
4095 if ( $editCount > $wgExperiencedUserEdits &&
4096 $registration <= $experiencedRegistration
4098 return 'experienced';
4105 * Persist this user's session (e.g. set cookies)
4107 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
4109 * @param bool|null $secure Whether to force secure/insecure cookies or use default
4110 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
4112 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
4114 if ( $this->mId
== 0 ) {
4118 $session = $this->getRequest()->getSession();
4119 if ( $request && $session->getRequest() !== $request ) {
4120 $session = $session->sessionWithRequest( $request );
4122 $delay = $session->delaySave();
4124 if ( !$session->getUser()->equals( $this ) ) {
4125 if ( !$session->canSetUser() ) {
4126 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4127 ->warning( __METHOD__
.
4128 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
4132 $session->setUser( $this );
4135 $session->setRememberUser( $rememberMe );
4136 if ( $secure !== null ) {
4137 $session->setForceHTTPS( $secure );
4140 $session->persist();
4142 ScopedCallback
::consume( $delay );
4146 * Log this user out.
4148 public function logout() {
4149 // Avoid PHP 7.1 warning of passing $this by reference
4151 if ( Hooks
::run( 'UserLogout', [ &$user ] ) ) {
4157 * Clear the user's session, and reset the instance cache.
4160 public function doLogout() {
4161 $session = $this->getRequest()->getSession();
4162 if ( !$session->canSetUser() ) {
4163 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4164 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
4165 $error = 'immutable';
4166 } elseif ( !$session->getUser()->equals( $this ) ) {
4167 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
4168 ->warning( __METHOD__
.
4169 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
4171 // But we still may as well make this user object anon
4172 $this->clearInstanceCache( 'defaults' );
4173 $error = 'wronguser';
4175 $this->clearInstanceCache( 'defaults' );
4176 $delay = $session->delaySave();
4177 $session->unpersist(); // Clear cookies (T127436)
4178 $session->setLoggedOutTimestamp( time() );
4179 $session->setUser( new User
);
4180 $session->set( 'wsUserID', 0 ); // Other code expects this
4181 $session->resetAllTokens();
4182 ScopedCallback
::consume( $delay );
4185 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authevents' )->info( 'Logout', [
4186 'event' => 'logout',
4187 'successful' => $error === false,
4188 'status' => $error ?
: 'success',
4193 * Save this user's settings into the database.
4194 * @todo Only rarely do all these fields need to be set!
4196 public function saveSettings() {
4197 if ( wfReadOnly() ) {
4198 // @TODO: caller should deal with this instead!
4199 // This should really just be an exception.
4200 MWExceptionHandler
::logException( new DBExpectedError(
4202 "Could not update user with ID '{$this->mId}'; DB is read-only."
4208 if ( $this->mId
== 0 ) {
4212 // Get a new user_touched that is higher than the old one.
4213 // This will be used for a CAS check as a last-resort safety
4214 // check against race conditions and replica DB lag.
4215 $newTouched = $this->newTouchedTimestamp();
4217 $dbw = wfGetDB( DB_MASTER
);
4218 $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $newTouched ) {
4219 global $wgActorTableSchemaMigrationStage;
4221 $dbw->update( 'user',
4223 'user_name' => $this->mName
,
4224 'user_real_name' => $this->mRealName
,
4225 'user_email' => $this->mEmail
,
4226 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4227 'user_touched' => $dbw->timestamp( $newTouched ),
4228 'user_token' => strval( $this->mToken
),
4229 'user_email_token' => $this->mEmailToken
,
4230 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
4231 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
4232 'user_id' => $this->mId
,
4236 if ( !$dbw->affectedRows() ) {
4237 // Maybe the problem was a missed cache update; clear it to be safe
4238 $this->clearSharedCache( 'refresh' );
4239 // User was changed in the meantime or loaded with stale data
4240 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'replica';
4241 LoggerFactory
::getInstance( 'preferences' )->warning(
4242 "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
4243 [ 'user_id' => $this->mId
, 'db_flag' => $from ]
4245 throw new MWException( "CAS update failed on user_touched. " .
4246 "The version of the user to be saved is older than the current version."
4250 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4253 [ 'actor_name' => $this->mName
],
4254 [ 'actor_user' => $this->mId
],
4260 $this->mTouched
= $newTouched;
4261 $this->saveOptions();
4263 Hooks
::run( 'UserSaveSettings', [ $this ] );
4264 $this->clearSharedCache();
4265 $this->getUserPage()->purgeSquid();
4269 * If only this user's username is known, and it exists, return the user ID.
4271 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
4274 public function idForName( $flags = 0 ) {
4275 $s = trim( $this->getName() );
4280 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
4281 ?
wfGetDB( DB_MASTER
)
4282 : wfGetDB( DB_REPLICA
);
4284 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
4285 ?
[ 'LOCK IN SHARE MODE' ]
4288 $id = $db->selectField( 'user',
4289 'user_id', [ 'user_name' => $s ], __METHOD__
, $options );
4295 * Add a user to the database, return the user object
4297 * @param string $name Username to add
4298 * @param array $params Array of Strings Non-default parameters to save to
4299 * the database as user_* fields:
4300 * - email: The user's email address.
4301 * - email_authenticated: The email authentication timestamp.
4302 * - real_name: The user's real name.
4303 * - options: An associative array of non-default options.
4304 * - token: Random authentication token. Do not set.
4305 * - registration: Registration timestamp. Do not set.
4307 * @return User|null User object, or null if the username already exists.
4309 public static function createNew( $name, $params = [] ) {
4310 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
4311 if ( isset( $params[$field] ) ) {
4312 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
4313 unset( $params[$field] );
4319 $user->setToken(); // init token
4320 if ( isset( $params['options'] ) ) {
4321 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
4322 unset( $params['options'] );
4324 $dbw = wfGetDB( DB_MASTER
);
4326 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4329 'user_name' => $name,
4330 'user_password' => $noPass,
4331 'user_newpassword' => $noPass,
4332 'user_email' => $user->mEmail
,
4333 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
4334 'user_real_name' => $user->mRealName
,
4335 'user_token' => strval( $user->mToken
),
4336 'user_registration' => $dbw->timestamp( $user->mRegistration
),
4337 'user_editcount' => 0,
4338 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4340 foreach ( $params as $name => $value ) {
4341 $fields["user_$name"] = $value;
4344 return $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) use ( $fields ) {
4345 $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
4346 if ( $dbw->affectedRows() ) {
4347 $newUser = self
::newFromId( $dbw->insertId() );
4348 $newUser->mName
= $fields['user_name'];
4349 $newUser->updateActorId( $dbw );
4350 // Load the user from master to avoid replica lag
4351 $newUser->load( self
::READ_LATEST
);
4360 * Add this existing user object to the database. If the user already
4361 * exists, a fatal status object is returned, and the user object is
4362 * initialised with the data from the database.
4364 * Previously, this function generated a DB error due to a key conflict
4365 * if the user already existed. Many extension callers use this function
4366 * in code along the lines of:
4368 * $user = User::newFromName( $name );
4369 * if ( !$user->isLoggedIn() ) {
4370 * $user->addToDatabase();
4372 * // do something with $user...
4374 * However, this was vulnerable to a race condition (T18020). By
4375 * initialising the user object if the user exists, we aim to support this
4376 * calling sequence as far as possible.
4378 * Note that if the user exists, this function will acquire a write lock,
4379 * so it is still advisable to make the call conditional on isLoggedIn(),
4380 * and to commit the transaction after calling.
4382 * @throws MWException
4385 public function addToDatabase() {
4387 if ( !$this->mToken
) {
4388 $this->setToken(); // init token
4391 if ( !is_string( $this->mName
) ) {
4392 throw new RuntimeException( "User name field is not set." );
4395 $this->mTouched
= $this->newTouchedTimestamp();
4397 $dbw = wfGetDB( DB_MASTER
);
4398 $status = $dbw->doAtomicSection( __METHOD__
, function ( $dbw, $fname ) {
4399 $noPass = PasswordFactory
::newInvalidPassword()->toString();
4400 $dbw->insert( 'user',
4402 'user_name' => $this->mName
,
4403 'user_password' => $noPass,
4404 'user_newpassword' => $noPass,
4405 'user_email' => $this->mEmail
,
4406 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
4407 'user_real_name' => $this->mRealName
,
4408 'user_token' => strval( $this->mToken
),
4409 'user_registration' => $dbw->timestamp( $this->mRegistration
),
4410 'user_editcount' => 0,
4411 'user_touched' => $dbw->timestamp( $this->mTouched
),
4415 if ( !$dbw->affectedRows() ) {
4416 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4417 $this->mId
= $dbw->selectField(
4420 [ 'user_name' => $this->mName
],
4422 [ 'LOCK IN SHARE MODE' ]
4426 if ( $this->loadFromDatabase( self
::READ_LOCKING
) ) {
4431 throw new MWException( $fname . ": hit a key conflict attempting " .
4432 "to insert user '{$this->mName}' row, but it was not present in select!" );
4434 return Status
::newFatal( 'userexists' );
4436 $this->mId
= $dbw->insertId();
4437 self
::$idCacheByName[$this->mName
] = $this->mId
;
4438 $this->updateActorId( $dbw );
4440 return Status
::newGood();
4442 if ( !$status->isGood() ) {
4446 // Clear instance cache other than user table data and actor, which is already accurate
4447 $this->clearInstanceCache();
4449 $this->saveOptions();
4450 return Status
::newGood();
4454 * Update the actor ID after an insert
4455 * @param IDatabase $dbw Writable database handle
4457 private function updateActorId( IDatabase
$dbw ) {
4458 global $wgActorTableSchemaMigrationStage;
4460 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
4463 [ 'actor_user' => $this->mId
, 'actor_name' => $this->mName
],
4466 $this->mActorId
= (int)$dbw->insertId();
4471 * If this user is logged-in and blocked,
4472 * block any IP address they've successfully logged in from.
4473 * @return bool A block was spread
4475 public function spreadAnyEditBlock() {
4476 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4477 return $this->spreadBlock();
4484 * If this (non-anonymous) user is blocked,
4485 * block the IP address they've successfully logged in from.
4486 * @return bool A block was spread
4488 protected function spreadBlock() {
4489 wfDebug( __METHOD__
. "()\n" );
4491 if ( $this->mId
== 0 ) {
4495 $userblock = Block
::newFromTarget( $this->getName() );
4496 if ( !$userblock ) {
4500 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4504 * Get whether the user is explicitly blocked from account creation.
4505 * @return bool|Block
4507 public function isBlockedFromCreateAccount() {
4508 $this->getBlockedStatus();
4509 if ( $this->mBlock
&& $this->mBlock
->appliesToRight( 'createaccount' ) ) {
4510 return $this->mBlock
;
4513 # T15611: if the IP address the user is trying to create an account from is
4514 # blocked with createaccount disabled, prevent new account creation there even
4515 # when the user is logged in
4516 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4517 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
4519 return $this->mBlockedFromCreateAccount
instanceof Block
4520 && $this->mBlockedFromCreateAccount
->appliesToRight( 'createaccount' )
4521 ?
$this->mBlockedFromCreateAccount
4526 * Get whether the user is blocked from using Special:Emailuser.
4529 public function isBlockedFromEmailuser() {
4530 $this->getBlockedStatus();
4531 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'sendemail' );
4535 * Get whether the user is blocked from using Special:Upload
4540 public function isBlockedFromUpload() {
4541 $this->getBlockedStatus();
4542 return $this->mBlock
&& $this->mBlock
->appliesToRight( 'upload' );
4546 * Get whether the user is allowed to create an account.
4549 public function isAllowedToCreateAccount() {
4550 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4554 * Get this user's personal page title.
4556 * @return Title User's personal page title
4558 public function getUserPage() {
4559 return Title
::makeTitle( NS_USER
, $this->getName() );
4563 * Get this user's talk page title.
4565 * @return Title User's talk page title
4567 public function getTalkPage() {
4568 $title = $this->getUserPage();
4569 return $title->getTalkPage();
4573 * Determine whether the user is a newbie. Newbies are either
4574 * anonymous IPs, or the most recently created accounts.
4577 public function isNewbie() {
4578 return !$this->isAllowed( 'autoconfirmed' );
4582 * Check to see if the given clear-text password is one of the accepted passwords
4583 * @deprecated since 1.27, use AuthManager instead
4584 * @param string $password User password
4585 * @return bool True if the given password is correct, otherwise False
4587 public function checkPassword( $password ) {
4588 wfDeprecated( __METHOD__
, '1.27' );
4590 $manager = AuthManager
::singleton();
4591 $reqs = AuthenticationRequest
::loadRequestsFromSubmission(
4592 $manager->getAuthenticationRequests( AuthManager
::ACTION_LOGIN
),
4594 'username' => $this->getName(),
4595 'password' => $password,
4598 $res = AuthManager
::singleton()->beginAuthentication( $reqs, 'null:' );
4599 switch ( $res->status
) {
4600 case AuthenticationResponse
::PASS
:
4602 case AuthenticationResponse
::FAIL
:
4603 // Hope it's not a PreAuthenticationProvider that failed...
4604 \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' )
4605 ->info( __METHOD__
. ': Authentication failed: ' . $res->message
->plain() );
4608 throw new BadMethodCallException(
4609 'AuthManager returned a response unsupported by ' . __METHOD__
4615 * Check if the given clear-text password matches the temporary password
4616 * sent by e-mail for password reset operations.
4618 * @deprecated since 1.27, use AuthManager instead
4619 * @param string $plaintext
4620 * @return bool True if matches, false otherwise
4622 public function checkTemporaryPassword( $plaintext ) {
4623 wfDeprecated( __METHOD__
, '1.27' );
4624 // Can't check the temporary password individually.
4625 return $this->checkPassword( $plaintext );
4629 * Initialize (if necessary) and return a session token value
4630 * which can be used in edit forms to show that the user's
4631 * login credentials aren't being hijacked with a foreign form
4635 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4636 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4637 * @return MediaWiki\Session\Token The new edit token
4639 public function getEditTokenObject( $salt = '', $request = null ) {
4640 if ( $this->isAnon() ) {
4641 return new LoggedOutEditToken();
4645 $request = $this->getRequest();
4647 return $request->getSession()->getToken( $salt );
4651 * Initialize (if necessary) and return a session token value
4652 * which can be used in edit forms to show that the user's
4653 * login credentials aren't being hijacked with a foreign form
4656 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4659 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4660 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4661 * @return string The new edit token
4663 public function getEditToken( $salt = '', $request = null ) {
4664 return $this->getEditTokenObject( $salt, $request )->toString();
4668 * Check given value against the token value stored in the session.
4669 * A match should confirm that the form was submitted from the
4670 * user's own login session, not a form submission from a third-party
4673 * @param string $val Input value to compare
4674 * @param string|array $salt Optional function-specific data for hashing
4675 * @param WebRequest|null $request Object to use or null to use $wgRequest
4676 * @param int|null $maxage Fail tokens older than this, in seconds
4677 * @return bool Whether the token matches
4679 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4680 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4684 * Check given value against the token value stored in the session,
4685 * ignoring the suffix.
4687 * @param string $val Input value to compare
4688 * @param string|array $salt Optional function-specific data for hashing
4689 * @param WebRequest|null $request Object to use or null to use $wgRequest
4690 * @param int|null $maxage Fail tokens older than this, in seconds
4691 * @return bool Whether the token matches
4693 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4694 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token
::SUFFIX
;
4695 return $this->matchEditToken( $val, $salt, $request, $maxage );
4699 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4700 * mail to the user's given address.
4702 * @param string $type Message to send, either "created", "changed" or "set"
4705 public function sendConfirmationMail( $type = 'created' ) {
4707 $expiration = null; // gets passed-by-ref and defined in next line.
4708 $token = $this->confirmationToken( $expiration );
4709 $url = $this->confirmationTokenUrl( $token );
4710 $invalidateURL = $this->invalidationTokenUrl( $token );
4711 $this->saveSettings();
4713 if ( $type == 'created' ||
$type === false ) {
4714 $message = 'confirmemail_body';
4716 } elseif ( $type === true ) {
4717 $message = 'confirmemail_body_changed';
4720 // Messages: confirmemail_body_changed, confirmemail_body_set
4721 $message = 'confirmemail_body_' . $type;
4725 'subject' => wfMessage( 'confirmemail_subject' )->text(),
4726 'body' => wfMessage( $message,
4727 $this->getRequest()->getIP(),
4730 $wgLang->userTimeAndDate( $expiration, $this ),
4732 $wgLang->userDate( $expiration, $this ),
4733 $wgLang->userTime( $expiration, $this ) )->text(),
4739 'ip' => $this->getRequest()->getIP(),
4740 'confirmURL' => $url,
4741 'invalidateURL' => $invalidateURL,
4742 'expiration' => $expiration
4745 Hooks
::run( 'UserSendConfirmationMail', [ $this, &$mail, $info ] );
4746 return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
4750 * Send an e-mail to this user's account. Does not check for
4751 * confirmed status or validity.
4753 * @param string $subject Message subject
4754 * @param string $body Message body
4755 * @param User|null $from Optional sending user; if unspecified, default
4756 * $wgPasswordSender will be used.
4757 * @param MailAddress|null $replyto Reply-To address
4760 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4761 global $wgPasswordSender;
4763 if ( $from instanceof User
) {
4764 $sender = MailAddress
::newFromUser( $from );
4766 $sender = new MailAddress( $wgPasswordSender,
4767 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4769 $to = MailAddress
::newFromUser( $this );
4771 return UserMailer
::send( $to, $sender, $subject, $body, [
4772 'replyTo' => $replyto,
4777 * Generate, store, and return a new e-mail confirmation code.
4778 * A hash (unsalted, since it's used as a key) is stored.
4780 * @note Call saveSettings() after calling this function to commit
4781 * this change to the database.
4783 * @param string &$expiration Accepts the expiration time
4784 * @return string New token
4786 protected function confirmationToken( &$expiration ) {
4787 global $wgUserEmailConfirmationTokenExpiry;
4789 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4790 $expiration = wfTimestamp( TS_MW
, $expires );
4792 $token = MWCryptRand
::generateHex( 32 );
4793 $hash = md5( $token );
4794 $this->mEmailToken
= $hash;
4795 $this->mEmailTokenExpires
= $expiration;
4800 * Return a URL the user can use to confirm their email address.
4801 * @param string $token Accepts the email confirmation token
4802 * @return string New token URL
4804 protected function confirmationTokenUrl( $token ) {
4805 return $this->getTokenUrl( 'ConfirmEmail', $token );
4809 * Return a URL the user can use to invalidate their email address.
4810 * @param string $token Accepts the email confirmation token
4811 * @return string New token URL
4813 protected function invalidationTokenUrl( $token ) {
4814 return $this->getTokenUrl( 'InvalidateEmail', $token );
4818 * Internal function to format the e-mail validation/invalidation URLs.
4819 * This uses a quickie hack to use the
4820 * hardcoded English names of the Special: pages, for ASCII safety.
4822 * @note Since these URLs get dropped directly into emails, using the
4823 * short English names avoids insanely long URL-encoded links, which
4824 * also sometimes can get corrupted in some browsers/mailers
4825 * (T8957 with Gmail and Internet Explorer).
4827 * @param string $page Special page
4828 * @param string $token
4829 * @return string Formatted URL
4831 protected function getTokenUrl( $page, $token ) {
4832 // Hack to bypass localization of 'Special:'
4833 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4834 return $title->getCanonicalURL();
4838 * Mark the e-mail address confirmed.
4840 * @note Call saveSettings() after calling this function to commit the change.
4844 public function confirmEmail() {
4845 // Check if it's already confirmed, so we don't touch the database
4846 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4847 if ( !$this->isEmailConfirmed() ) {
4848 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4849 Hooks
::run( 'ConfirmEmailComplete', [ $this ] );
4855 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4856 * address if it was already confirmed.
4858 * @note Call saveSettings() after calling this function to commit the change.
4859 * @return bool Returns true
4861 public function invalidateEmail() {
4863 $this->mEmailToken
= null;
4864 $this->mEmailTokenExpires
= null;
4865 $this->setEmailAuthenticationTimestamp( null );
4867 Hooks
::run( 'InvalidateEmailComplete', [ $this ] );
4872 * Set the e-mail authentication timestamp.
4873 * @param string $timestamp TS_MW timestamp
4875 public function setEmailAuthenticationTimestamp( $timestamp ) {
4877 $this->mEmailAuthenticated
= $timestamp;
4878 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated
] );
4882 * Is this user allowed to send e-mails within limits of current
4883 * site configuration?
4886 public function canSendEmail() {
4887 global $wgEnableEmail, $wgEnableUserEmail;
4888 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4891 $canSend = $this->isEmailConfirmed();
4892 // Avoid PHP 7.1 warning of passing $this by reference
4894 Hooks
::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
4899 * Is this user allowed to receive e-mails within limits of current
4900 * site configuration?
4903 public function canReceiveEmail() {
4904 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4908 * Is this user's e-mail address valid-looking and confirmed within
4909 * limits of the current site configuration?
4911 * @note If $wgEmailAuthentication is on, this may require the user to have
4912 * confirmed their address by returning a code or using a password
4913 * sent to the address from the wiki.
4917 public function isEmailConfirmed() {
4918 global $wgEmailAuthentication;
4920 // Avoid PHP 7.1 warning of passing $this by reference
4923 if ( Hooks
::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
4924 if ( $this->isAnon() ) {
4927 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4930 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4940 * Check whether there is an outstanding request for e-mail confirmation.
4943 public function isEmailConfirmationPending() {
4944 global $wgEmailAuthentication;
4945 return $wgEmailAuthentication &&
4946 !$this->isEmailConfirmed() &&
4947 $this->mEmailToken
&&
4948 $this->mEmailTokenExpires
> wfTimestamp();
4952 * Get the timestamp of account creation.
4954 * @return string|bool|null Timestamp of account creation, false for
4955 * non-existent/anonymous user accounts, or null if existing account
4956 * but information is not in database.
4958 public function getRegistration() {
4959 if ( $this->isAnon() ) {
4963 return $this->mRegistration
;
4967 * Get the timestamp of the first edit
4969 * @return string|bool Timestamp of first edit, or false for
4970 * non-existent/anonymous user accounts.
4972 public function getFirstEditTimestamp() {
4973 return $this->getEditTimestamp( true );
4977 * Get the timestamp of the latest edit
4980 * @return string|bool Timestamp of first edit, or false for
4981 * non-existent/anonymous user accounts.
4983 public function getLatestEditTimestamp() {
4984 return $this->getEditTimestamp( false );
4988 * Get the timestamp of the first or latest edit
4990 * @param bool $first True for the first edit, false for the latest one
4991 * @return string|bool Timestamp of first or latest edit, or false for
4992 * non-existent/anonymous user accounts.
4994 private function getEditTimestamp( $first ) {
4995 if ( $this->getId() == 0 ) {
4996 return false; // anons
4998 $dbr = wfGetDB( DB_REPLICA
);
4999 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5000 $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
5001 ?
'revactor_timestamp' : 'rev_timestamp';
5002 $sortOrder = $first ?
'ASC' : 'DESC';
5003 $time = $dbr->selectField(
5004 [ 'revision' ] +
$actorWhere['tables'],
5006 [ $actorWhere['conds'] ],
5008 [ 'ORDER BY' => "$tsField $sortOrder" ],
5009 $actorWhere['joins']
5012 return false; // no edits
5014 return wfTimestamp( TS_MW
, $time );
5018 * Get the permissions associated with a given list of groups
5020 * @param array $groups Array of Strings List of internal group names
5021 * @return array Array of Strings List of permission key names for given groups combined
5023 public static function getGroupPermissions( $groups ) {
5024 global $wgGroupPermissions, $wgRevokePermissions;
5026 // grant every granted permission first
5027 foreach ( $groups as $group ) {
5028 if ( isset( $wgGroupPermissions[$group] ) ) {
5029 $rights = array_merge( $rights,
5030 // array_filter removes empty items
5031 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
5034 // now revoke the revoked permissions
5035 foreach ( $groups as $group ) {
5036 if ( isset( $wgRevokePermissions[$group] ) ) {
5037 $rights = array_diff( $rights,
5038 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
5041 return array_unique( $rights );
5045 * Get all the groups who have a given permission
5047 * @param string $role Role to check
5048 * @return array Array of Strings List of internal group names with the given permission
5050 public static function getGroupsWithPermission( $role ) {
5051 global $wgGroupPermissions;
5052 $allowedGroups = [];
5053 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
5054 if ( self
::groupHasPermission( $group, $role ) ) {
5055 $allowedGroups[] = $group;
5058 return $allowedGroups;
5062 * Check, if the given group has the given permission
5064 * If you're wanting to check whether all users have a permission, use
5065 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
5069 * @param string $group Group to check
5070 * @param string $role Role to check
5073 public static function groupHasPermission( $group, $role ) {
5074 global $wgGroupPermissions, $wgRevokePermissions;
5075 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
5076 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
5080 * Check if all users may be assumed to have the given permission
5082 * We generally assume so if the right is granted to '*' and isn't revoked
5083 * on any group. It doesn't attempt to take grants or other extension
5084 * limitations on rights into account in the general case, though, as that
5085 * would require it to always return false and defeat the purpose.
5086 * Specifically, session-based rights restrictions (such as OAuth or bot
5087 * passwords) are applied based on the current session.
5090 * @param string $right Right to check
5093 public static function isEveryoneAllowed( $right ) {
5094 global $wgGroupPermissions, $wgRevokePermissions;
5097 // Use the cached results, except in unit tests which rely on
5098 // being able change the permission mid-request
5099 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
5100 return $cache[$right];
5103 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
5104 $cache[$right] = false;
5108 // If it's revoked anywhere, then everyone doesn't have it
5109 foreach ( $wgRevokePermissions as $rights ) {
5110 if ( isset( $rights[$right] ) && $rights[$right] ) {
5111 $cache[$right] = false;
5116 // Remove any rights that aren't allowed to the global-session user,
5117 // unless there are no sessions for this endpoint.
5118 if ( !defined( 'MW_NO_SESSION' ) ) {
5119 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
5120 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
5121 $cache[$right] = false;
5126 // Allow extensions to say false
5127 if ( !Hooks
::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
5128 $cache[$right] = false;
5132 $cache[$right] = true;
5137 * Return the set of defined explicit groups.
5138 * The implicit groups (by default *, 'user' and 'autoconfirmed')
5139 * are not included, as they are defined automatically, not in the database.
5140 * @return array Array of internal group names
5142 public static function getAllGroups() {
5143 global $wgGroupPermissions, $wgRevokePermissions;
5144 return array_values( array_diff(
5145 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
5146 self
::getImplicitGroups()
5151 * Get a list of all available permissions.
5152 * @return string[] Array of permission names
5154 public static function getAllRights() {
5155 if ( self
::$mAllRights === false ) {
5156 global $wgAvailableRights;
5157 if ( count( $wgAvailableRights ) ) {
5158 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
5160 self
::$mAllRights = self
::$mCoreRights;
5162 Hooks
::run( 'UserGetAllRights', [ &self
::$mAllRights ] );
5164 return self
::$mAllRights;
5168 * Get a list of implicit groups
5169 * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
5171 * @return array Array of Strings Array of internal group names
5173 public static function getImplicitGroups() {
5174 global $wgImplicitGroups;
5175 return $wgImplicitGroups;
5179 * Get the title of a page describing a particular group
5180 * @deprecated since 1.29 Use UserGroupMembership::getGroupPage instead
5182 * @param string $group Internal group name
5183 * @return Title|bool Title of the page if it exists, false otherwise
5185 public static function getGroupPage( $group ) {
5186 wfDeprecated( __METHOD__
, '1.29' );
5187 return UserGroupMembership
::getGroupPage( $group );
5191 * Create a link to the group in HTML, if available;
5192 * else return the group name.
5193 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5194 * make the link yourself if you need custom text
5196 * @param string $group Internal name of the group
5197 * @param string $text The text of the link
5198 * @return string HTML link to the group
5200 public static function makeGroupLinkHTML( $group, $text = '' ) {
5201 wfDeprecated( __METHOD__
, '1.29' );
5203 if ( $text == '' ) {
5204 $text = UserGroupMembership
::getGroupName( $group );
5206 $title = UserGroupMembership
::getGroupPage( $group );
5208 return MediaWikiServices
::getInstance()
5209 ->getLinkRenderer()->makeLink( $title, $text );
5212 return htmlspecialchars( $text );
5216 * Create a link to the group in Wikitext, if available;
5217 * else return the group name.
5218 * @deprecated since 1.29 Use UserGroupMembership::getLink instead, or
5219 * make the link yourself if you need custom text
5221 * @param string $group Internal name of the group
5222 * @param string $text The text of the link
5223 * @return string Wikilink to the group
5225 public static function makeGroupLinkWiki( $group, $text = '' ) {
5226 wfDeprecated( __METHOD__
, '1.29' );
5228 if ( $text == '' ) {
5229 $text = UserGroupMembership
::getGroupName( $group );
5231 $title = UserGroupMembership
::getGroupPage( $group );
5233 $page = $title->getFullText();
5234 return "[[$page|$text]]";
5241 * Returns an array of the groups that a particular group can add/remove.
5243 * @param string $group The group to check for whether it can add/remove
5244 * @return array Array( 'add' => array( addablegroups ),
5245 * 'remove' => array( removablegroups ),
5246 * 'add-self' => array( addablegroups to self),
5247 * 'remove-self' => array( removable groups from self) )
5249 public static function changeableByGroup( $group ) {
5250 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
5259 if ( empty( $wgAddGroups[$group] ) ) {
5260 // Don't add anything to $groups
5261 } elseif ( $wgAddGroups[$group] === true ) {
5262 // You get everything
5263 $groups['add'] = self
::getAllGroups();
5264 } elseif ( is_array( $wgAddGroups[$group] ) ) {
5265 $groups['add'] = $wgAddGroups[$group];
5268 // Same thing for remove
5269 if ( empty( $wgRemoveGroups[$group] ) ) {
5271 } elseif ( $wgRemoveGroups[$group] === true ) {
5272 $groups['remove'] = self
::getAllGroups();
5273 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
5274 $groups['remove'] = $wgRemoveGroups[$group];
5277 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
5278 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
5279 foreach ( $wgGroupsAddToSelf as $key => $value ) {
5280 if ( is_int( $key ) ) {
5281 $wgGroupsAddToSelf['user'][] = $value;
5286 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
5287 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
5288 if ( is_int( $key ) ) {
5289 $wgGroupsRemoveFromSelf['user'][] = $value;
5294 // Now figure out what groups the user can add to him/herself
5295 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
5297 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
5298 // No idea WHY this would be used, but it's there
5299 $groups['add-self'] = self
::getAllGroups();
5300 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
5301 $groups['add-self'] = $wgGroupsAddToSelf[$group];
5304 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
5306 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
5307 $groups['remove-self'] = self
::getAllGroups();
5308 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
5309 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
5316 * Returns an array of groups that this user can add and remove
5317 * @return array Array( 'add' => array( addablegroups ),
5318 * 'remove' => array( removablegroups ),
5319 * 'add-self' => array( addablegroups to self),
5320 * 'remove-self' => array( removable groups from self) )
5322 public function changeableGroups() {
5323 if ( $this->isAllowed( 'userrights' ) ) {
5324 // This group gives the right to modify everything (reverse-
5325 // compatibility with old "userrights lets you change
5327 // Using array_merge to make the groups reindexed
5328 $all = array_merge( self
::getAllGroups() );
5337 // Okay, it's not so simple, we will have to go through the arrays
5344 $addergroups = $this->getEffectiveGroups();
5346 foreach ( $addergroups as $addergroup ) {
5347 $groups = array_merge_recursive(
5348 $groups, $this->changeableByGroup( $addergroup )
5350 $groups['add'] = array_unique( $groups['add'] );
5351 $groups['remove'] = array_unique( $groups['remove'] );
5352 $groups['add-self'] = array_unique( $groups['add-self'] );
5353 $groups['remove-self'] = array_unique( $groups['remove-self'] );
5359 * Schedule a deferred update to update the user's edit count
5361 public function incEditCount() {
5362 if ( $this->isAnon() ) {
5366 DeferredUpdates
::addUpdate(
5367 new UserEditCountUpdate( $this, 1 ),
5368 DeferredUpdates
::POSTSEND
5373 * This method should not be called outside User/UserEditCountUpdate
5377 public function setEditCountInternal( $count ) {
5378 $this->mEditCount
= $count;
5382 * Initialize user_editcount from data out of the revision table
5384 * This method should not be called outside User/UserEditCountUpdate
5386 * @return int Number of edits
5388 public function initEditCountInternal() {
5389 // Pull from a replica DB to be less cruel to servers
5390 // Accuracy isn't the point anyway here
5391 $dbr = wfGetDB( DB_REPLICA
);
5392 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbr, 'rev_user', $this );
5393 $count = (int)$dbr->selectField(
5394 [ 'revision' ] +
$actorWhere['tables'],
5396 [ $actorWhere['conds'] ],
5399 $actorWhere['joins']
5402 $dbw = wfGetDB( DB_MASTER
);
5405 [ 'user_editcount' => $count ],
5407 'user_id' => $this->getId(),
5408 'user_editcount IS NULL OR user_editcount < ' . (int)$count
5417 * Get the description of a given right
5420 * @param string $right Right to query
5421 * @return string Localized description of the right
5423 public static function getRightDescription( $right ) {
5424 $key = "right-$right";
5425 $msg = wfMessage( $key );
5426 return $msg->isDisabled() ?
$right : $msg->text();
5430 * Get the name of a given grant
5433 * @param string $grant Grant to query
5434 * @return string Localized name of the grant
5436 public static function getGrantName( $grant ) {
5437 $key = "grant-$grant";
5438 $msg = wfMessage( $key );
5439 return $msg->isDisabled() ?
$grant : $msg->text();
5443 * Add a newuser log entry for this user.
5444 * Before 1.19 the return value was always true.
5446 * @deprecated since 1.27, AuthManager handles logging
5447 * @param string|bool $action Account creation type.
5448 * - String, one of the following values:
5449 * - 'create' for an anonymous user creating an account for himself.
5450 * This will force the action's performer to be the created user itself,
5451 * no matter the value of $wgUser
5452 * - 'create2' for a logged in user creating an account for someone else
5453 * - 'byemail' when the created user will receive its password by e-mail
5454 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5455 * - Boolean means whether the account was created by e-mail (deprecated):
5456 * - true will be converted to 'byemail'
5457 * - false will be converted to 'create' if this object is the same as
5458 * $wgUser and to 'create2' otherwise
5459 * @param string $reason User supplied reason
5462 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5463 return true; // disabled
5467 * Add an autocreate newuser log entry for this user
5468 * Used by things like CentralAuth and perhaps other authplugins.
5469 * Consider calling addNewUserLogEntry() directly instead.
5471 * @deprecated since 1.27, AuthManager handles logging
5474 public function addNewUserLogEntryAutoCreate() {
5475 $this->addNewUserLogEntry( 'autocreate' );
5481 * Load the user options either from cache, the database or an array
5483 * @param array|null $data Rows for the current user out of the user_properties table
5485 protected function loadOptions( $data = null ) {
5488 if ( $this->mOptionsLoaded
) {
5492 $this->mOptions
= self
::getDefaultOptions();
5494 if ( !$this->getId() ) {
5495 // For unlogged-in users, load language/variant options from request.
5496 // There's no need to do it for logged-in users: they can set preferences,
5497 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5498 // so don't override user's choice (especially when the user chooses site default).
5499 $variant = MediaWikiServices
::getInstance()->getContentLanguage()->getDefaultVariant();
5500 $this->mOptions
['variant'] = $variant;
5501 $this->mOptions
['language'] = $variant;
5502 $this->mOptionsLoaded
= true;
5506 // Maybe load from the object
5507 if ( !is_null( $this->mOptionOverrides
) ) {
5508 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5509 foreach ( $this->mOptionOverrides
as $key => $value ) {
5510 $this->mOptions
[$key] = $value;
5513 if ( !is_array( $data ) ) {
5514 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5515 // Load from database
5516 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5517 ?
wfGetDB( DB_MASTER
)
5518 : wfGetDB( DB_REPLICA
);
5520 $res = $dbr->select(
5522 [ 'up_property', 'up_value' ],
5523 [ 'up_user' => $this->getId() ],
5527 $this->mOptionOverrides
= [];
5529 foreach ( $res as $row ) {
5530 // Convert '0' to 0. PHP's boolean conversion considers them both
5531 // false, but e.g. JavaScript considers the former as true.
5532 // @todo: T54542 Somehow determine the desired type (string/int/bool)
5533 // and convert all values here.
5534 if ( $row->up_value
=== '0' ) {
5537 $data[$row->up_property
] = $row->up_value
;
5541 foreach ( $data as $property => $value ) {
5542 $this->mOptionOverrides
[$property] = $value;
5543 $this->mOptions
[$property] = $value;
5547 // Replace deprecated language codes
5548 $this->mOptions
['language'] = LanguageCode
::replaceDeprecatedCodes(
5549 $this->mOptions
['language']
5552 $this->mOptionsLoaded
= true;
5554 Hooks
::run( 'UserLoadOptions', [ $this, &$this->mOptions
] );
5558 * Saves the non-default options for this user, as previously set e.g. via
5559 * setOption(), in the database's "user_properties" (preferences) table.
5560 * Usually used via saveSettings().
5562 protected function saveOptions() {
5563 $this->loadOptions();
5565 // Not using getOptions(), to keep hidden preferences in database
5566 $saveOptions = $this->mOptions
;
5568 // Allow hooks to abort, for instance to save to a global profile.
5569 // Reset options to default state before saving.
5570 if ( !Hooks
::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5574 $userId = $this->getId();
5576 $insert_rows = []; // all the new preference rows
5577 foreach ( $saveOptions as $key => $value ) {
5578 // Don't bother storing default values
5579 $defaultOption = self
::getDefaultOption( $key );
5580 if ( ( $defaultOption === null && $value !== false && $value !== null )
5581 ||
$value != $defaultOption
5584 'up_user' => $userId,
5585 'up_property' => $key,
5586 'up_value' => $value,
5591 $dbw = wfGetDB( DB_MASTER
);
5593 $res = $dbw->select( 'user_properties',
5594 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__
);
5596 // Find prior rows that need to be removed or updated. These rows will
5597 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5599 foreach ( $res as $row ) {
5600 if ( !isset( $saveOptions[$row->up_property
] )
5601 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5603 $keysDelete[] = $row->up_property
;
5607 if ( count( $keysDelete ) ) {
5608 // Do the DELETE by PRIMARY KEY for prior rows.
5609 // In the past a very large portion of calls to this function are for setting
5610 // 'rememberpassword' for new accounts (a preference that has since been removed).
5611 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5612 // caused gap locks on [max user ID,+infinity) which caused high contention since
5613 // updates would pile up on each other as they are for higher (newer) user IDs.
5614 // It might not be necessary these days, but it shouldn't hurt either.
5615 $dbw->delete( 'user_properties',
5616 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__
);
5618 // Insert the new preference rows
5619 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, [ 'IGNORE' ] );
5623 * Return the list of user fields that should be selected to create
5624 * a new user object.
5625 * @deprecated since 1.31, use self::getQueryInfo() instead.
5628 public static function selectFields() {
5629 wfDeprecated( __METHOD__
, '1.31' );
5637 'user_email_authenticated',
5639 'user_email_token_expires',
5640 'user_registration',
5646 * Return the tables, fields, and join conditions to be selected to create
5647 * a new user object.
5649 * @return array With three keys:
5650 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
5651 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
5652 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
5654 public static function getQueryInfo() {
5655 global $wgActorTableSchemaMigrationStage;
5658 'tables' => [ 'user' ],
5666 'user_email_authenticated',
5668 'user_email_token_expires',
5669 'user_registration',
5675 // Technically we shouldn't allow this without SCHEMA_COMPAT_READ_NEW,
5676 // but it does little harm and might be needed for write callers loading a User.
5677 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_NEW
) {
5678 $ret['tables']['user_actor'] = 'actor';
5679 $ret['fields'][] = 'user_actor.actor_id';
5680 $ret['joins']['user_actor'] = [
5681 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) ?
'JOIN' : 'LEFT JOIN',
5682 [ 'user_actor.actor_user = user_id' ]
5690 * Factory function for fatal permission-denied errors
5693 * @param string $permission User right required
5696 static function newFatalPermissionDeniedStatus( $permission ) {
5700 foreach ( self
::getGroupsWithPermission( $permission ) as $group ) {
5701 $groups[] = UserGroupMembership
::getLink( $group, RequestContext
::getMain(), 'wiki' );
5705 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5708 return Status
::newFatal( 'badaccess-group0' );
5712 * Get a new instance of this user that was loaded from the master via a locking read
5714 * Use this instead of the main context User when updating that user. This avoids races
5715 * where that user was loaded from a replica DB or even the master but without proper locks.
5717 * @return User|null Returns null if the user was not found in the DB
5720 public function getInstanceForUpdate() {
5721 if ( !$this->getId() ) {
5722 return null; // anon
5725 $user = self
::newFromId( $this->getId() );
5726 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5734 * Checks if two user objects point to the same user.
5736 * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
5737 * @param UserIdentity $user
5740 public function equals( UserIdentity
$user ) {
5741 // XXX it's not clear whether central ID providers are supposed to obey this
5742 return $this->getName() === $user->getName();